Chris@1494: # encoding: utf-8
Chris@1494: #
Chris@1494: # Redmine - project management software
Chris@1494: # Copyright (C) 2006-2014  Jean-Philippe Lang
Chris@1494: #
Chris@1494: # This program is free software; you can redistribute it and/or
Chris@1494: # modify it under the terms of the GNU General Public License
Chris@1494: # as published by the Free Software Foundation; either version 2
Chris@1494: # of the License, or (at your option) any later version.
Chris@1494: #
Chris@1494: # This program is distributed in the hope that it will be useful,
Chris@1494: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1494: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1494: # GNU General Public License for more details.
Chris@1494: #
Chris@1494: # You should have received a copy of the GNU General Public License
Chris@1494: # along with this program; if not, write to the Free Software
Chris@1494: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1494: 
Chris@1494: module IssuesHelper
Chris@1494:   include ApplicationHelper
Chris@1494: 
Chris@1494:   def issue_list(issues, &block)
Chris@1494:     ancestors = []
Chris@1494:     issues.each do |issue|
Chris@1494:       while (ancestors.any? && !issue.is_descendant_of?(ancestors.last))
Chris@1494:         ancestors.pop
Chris@1494:       end
Chris@1494:       yield issue, ancestors.size
Chris@1494:       ancestors << issue unless issue.leaf?
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Renders a HTML/CSS tooltip
Chris@1494:   #
Chris@1494:   # To use, a trigger div is needed.  This is a div with the class of "tooltip"
Chris@1494:   # that contains this method wrapped in a span with the class of "tip"
Chris@1494:   #
Chris@1494:   #    <div class="tooltip"><%= link_to_issue(issue) %>
Chris@1494:   #      <span class="tip"><%= render_issue_tooltip(issue) %></span>
Chris@1494:   #    </div>
Chris@1494:   #
Chris@1494:   def render_issue_tooltip(issue)
Chris@1494:     @cached_label_status ||= l(:field_status)
Chris@1494:     @cached_label_start_date ||= l(:field_start_date)
Chris@1494:     @cached_label_due_date ||= l(:field_due_date)
Chris@1494:     @cached_label_assigned_to ||= l(:field_assigned_to)
Chris@1494:     @cached_label_priority ||= l(:field_priority)
Chris@1494:     @cached_label_project ||= l(:field_project)
Chris@1494: 
Chris@1494:     link_to_issue(issue) + "<br /><br />".html_safe +
Chris@1494:       "<strong>#{@cached_label_project}</strong>: #{link_to_project(issue.project)}<br />".html_safe +
Chris@1494:       "<strong>#{@cached_label_status}</strong>: #{h(issue.status.name)}<br />".html_safe +
Chris@1494:       "<strong>#{@cached_label_start_date}</strong>: #{format_date(issue.start_date)}<br />".html_safe +
Chris@1494:       "<strong>#{@cached_label_due_date}</strong>: #{format_date(issue.due_date)}<br />".html_safe +
Chris@1494:       "<strong>#{@cached_label_assigned_to}</strong>: #{h(issue.assigned_to)}<br />".html_safe +
Chris@1494:       "<strong>#{@cached_label_priority}</strong>: #{h(issue.priority.name)}".html_safe
Chris@1494:   end
Chris@1494: 
Chris@1494:   def issue_heading(issue)
Chris@1494:     h("#{issue.tracker} ##{issue.id}")
Chris@1494:   end
Chris@1494: 
Chris@1494:   def render_issue_subject_with_tree(issue)
Chris@1494:     s = ''
Chris@1494:     ancestors = issue.root? ? [] : issue.ancestors.visible.all
Chris@1494:     ancestors.each do |ancestor|
Chris@1494:       s << '<div>' + content_tag('p', link_to_issue(ancestor, :project => (issue.project_id != ancestor.project_id)))
Chris@1494:     end
Chris@1494:     s << '<div>'
Chris@1494:     subject = h(issue.subject)
Chris@1494:     if issue.is_private?
Chris@1494:       subject = content_tag('span', l(:field_is_private), :class => 'private') + ' ' + subject
Chris@1494:     end
Chris@1494:     s << content_tag('h3', subject)
Chris@1494:     s << '</div>' * (ancestors.size + 1)
Chris@1494:     s.html_safe
Chris@1494:   end
Chris@1494: 
Chris@1494:   def render_descendants_tree(issue)
Chris@1494:     s = '<form><table class="list issues">'
Chris@1494:     issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
Chris@1494:       css = "issue issue-#{child.id} hascontextmenu"
Chris@1494:       css << " idnt idnt-#{level}" if level > 0
Chris@1494:       s << content_tag('tr',
Chris@1494:              content_tag('td', check_box_tag("ids[]", child.id, false, :id => nil), :class => 'checkbox') +
Chris@1494:              content_tag('td', link_to_issue(child, :truncate => 60, :project => (issue.project_id != child.project_id)), :class => 'subject') +
Chris@1494:              content_tag('td', h(child.status)) +
Chris@1494:              content_tag('td', link_to_user(child.assigned_to)) +
Chris@1494:              content_tag('td', progress_bar(child.done_ratio, :width => '80px')),
Chris@1494:              :class => css)
Chris@1494:     end
Chris@1494:     s << '</table></form>'
Chris@1494:     s.html_safe
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Returns an array of error messages for bulk edited issues
Chris@1494:   def bulk_edit_error_messages(issues)
Chris@1494:     messages = {}
Chris@1494:     issues.each do |issue|
Chris@1494:       issue.errors.full_messages.each do |message|
Chris@1494:         messages[message] ||= []
Chris@1494:         messages[message] << issue
Chris@1494:       end
Chris@1494:     end
Chris@1494:     messages.map { |message, issues|
Chris@1494:       "#{message}: " + issues.map {|i| "##{i.id}"}.join(', ')
Chris@1494:     }
Chris@1494:  end
Chris@1494: 
Chris@1494:   # Returns a link for adding a new subtask to the given issue
Chris@1494:   def link_to_new_subtask(issue)
Chris@1494:     attrs = {
Chris@1494:       :tracker_id => issue.tracker,
Chris@1494:       :parent_issue_id => issue
Chris@1494:     }
Chris@1494:     link_to(l(:button_add), new_project_issue_path(issue.project, :issue => attrs))
Chris@1494:   end
Chris@1494: 
Chris@1494:   class IssueFieldsRows
Chris@1494:     include ActionView::Helpers::TagHelper
Chris@1494: 
Chris@1494:     def initialize
Chris@1494:       @left = []
Chris@1494:       @right = []
Chris@1494:     end
Chris@1494: 
Chris@1494:     def left(*args)
Chris@1494:       args.any? ? @left << cells(*args) : @left
Chris@1494:     end
Chris@1494: 
Chris@1494:     def right(*args)
Chris@1494:       args.any? ? @right << cells(*args) : @right
Chris@1494:     end
Chris@1494: 
Chris@1494:     def size
Chris@1494:       @left.size > @right.size ? @left.size : @right.size
Chris@1494:     end
Chris@1494: 
Chris@1494:     def to_html
Chris@1494:       html = ''.html_safe
Chris@1494:       blank = content_tag('th', '') + content_tag('td', '')
Chris@1494:       size.times do |i|
Chris@1494:         left = @left[i] || blank
Chris@1494:         right = @right[i] || blank
Chris@1494:         html << content_tag('tr', left + right)
Chris@1494:       end
Chris@1494:       html
Chris@1494:     end
Chris@1494: 
Chris@1494:     def cells(label, text, options={})
Chris@1494:       content_tag('th', "#{label}:", options) + content_tag('td', text, options)
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   def issue_fields_rows
Chris@1494:     r = IssueFieldsRows.new
Chris@1494:     yield r
Chris@1494:     r.to_html
Chris@1494:   end
Chris@1494: 
Chris@1494:   def render_custom_fields_rows(issue)
Chris@1494:     values = issue.visible_custom_field_values
Chris@1494:     return if values.empty?
Chris@1494:     ordered_values = []
Chris@1494:     half = (values.size / 2.0).ceil
Chris@1494:     half.times do |i|
Chris@1494:       ordered_values << values[i]
Chris@1494:       ordered_values << values[i + half]
Chris@1494:     end
Chris@1494:     s = "<tr>\n"
Chris@1494:     n = 0
Chris@1494:     ordered_values.compact.each do |value|
Chris@1494:       s << "</tr>\n<tr>\n" if n > 0 && (n % 2) == 0
Chris@1494:       s << "\t<th>#{ h(value.custom_field.name) }:</th><td>#{ simple_format_without_paragraph(h(show_value(value))) }</td>\n"
Chris@1494:       n += 1
Chris@1494:     end
Chris@1494:     s << "</tr>\n"
Chris@1494:     s.html_safe
Chris@1494:   end
Chris@1494: 
Chris@1494:   def issues_destroy_confirmation_message(issues)
Chris@1494:     issues = [issues] unless issues.is_a?(Array)
Chris@1494:     message = l(:text_issues_destroy_confirmation)
Chris@1494:     descendant_count = issues.inject(0) {|memo, i| memo += (i.right - i.left - 1)/2}
Chris@1494:     if descendant_count > 0
Chris@1494:       issues.each do |issue|
Chris@1494:         next if issue.root?
Chris@1494:         issues.each do |other_issue|
Chris@1494:           descendant_count -= 1 if issue.is_descendant_of?(other_issue)
Chris@1494:         end
Chris@1494:       end
Chris@1494:       if descendant_count > 0
Chris@1494:         message << "\n" + l(:text_issues_destroy_descendants_confirmation, :count => descendant_count)
Chris@1494:       end
Chris@1494:     end
Chris@1494:     message
Chris@1494:   end
Chris@1494: 
Chris@1494:   def sidebar_queries
Chris@1494:     unless @sidebar_queries
Chris@1494:       @sidebar_queries = IssueQuery.visible.
Chris@1494:         order("#{Query.table_name}.name ASC").
Chris@1494:         # Project specific queries and global queries
Chris@1494:         where(@project.nil? ? ["project_id IS NULL"] : ["project_id IS NULL OR project_id = ?", @project.id]).
Chris@1494:         all
Chris@1494:     end
Chris@1494:     @sidebar_queries
Chris@1494:   end
Chris@1494: 
Chris@1494:   def query_links(title, queries)
Chris@1494:     return '' if queries.empty?
Chris@1494:     # links to #index on issues/show
Chris@1494:     url_params = controller_name == 'issues' ? {:controller => 'issues', :action => 'index', :project_id => @project} : params
Chris@1494: 
Chris@1494:     content_tag('h3', title) + "\n" +
Chris@1494:       content_tag('ul',
Chris@1494:         queries.collect {|query|
Chris@1494:             css = 'query'
Chris@1494:             css << ' selected' if query == @query
Chris@1494:             content_tag('li', link_to(query.name, url_params.merge(:query_id => query), :class => css))
Chris@1494:           }.join("\n").html_safe,
Chris@1494:         :class => 'queries'
Chris@1494:       ) + "\n"
Chris@1494:   end
Chris@1494: 
Chris@1494:   def render_sidebar_queries
Chris@1494:     out = ''.html_safe
Chris@1494:     out << query_links(l(:label_my_queries), sidebar_queries.select(&:is_private?))
Chris@1494:     out << query_links(l(:label_query_plural), sidebar_queries.reject(&:is_private?))
Chris@1494:     out
Chris@1494:   end
Chris@1494: 
Chris@1494:   def email_issue_attributes(issue, user)
Chris@1494:     items = []
Chris@1494:     %w(author status priority assigned_to category fixed_version).each do |attribute|
Chris@1494:       unless issue.disabled_core_fields.include?(attribute+"_id")
Chris@1494:         items << "#{l("field_#{attribute}")}: #{issue.send attribute}"
Chris@1494:       end
Chris@1494:     end
Chris@1494:     issue.visible_custom_field_values(user).each do |value|
Chris@1494:       items << "#{value.custom_field.name}: #{show_value(value)}"
Chris@1494:     end
Chris@1494:     items
Chris@1494:   end
Chris@1494: 
Chris@1494:   def render_email_issue_attributes(issue, user, html=false)
Chris@1494:     items = email_issue_attributes(issue, user)
Chris@1494:     if html
Chris@1494:       content_tag('ul', items.map{|s| content_tag('li', s)}.join("\n").html_safe)
Chris@1494:     else
Chris@1494:       items.map{|s| "* #{s}"}.join("\n")
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Returns the textual representation of a journal details
Chris@1494:   # as an array of strings
Chris@1494:   def details_to_strings(details, no_html=false, options={})
Chris@1494:     options[:only_path] = (options[:only_path] == false ? false : true)
Chris@1494:     strings = []
Chris@1494:     values_by_field = {}
Chris@1494:     details.each do |detail|
Chris@1494:       if detail.property == 'cf'
Chris@1494:         field = detail.custom_field
Chris@1494:         if field && field.multiple?
Chris@1494:           values_by_field[field] ||= {:added => [], :deleted => []}
Chris@1494:           if detail.old_value
Chris@1494:             values_by_field[field][:deleted] << detail.old_value
Chris@1494:           end
Chris@1494:           if detail.value
Chris@1494:             values_by_field[field][:added] << detail.value
Chris@1494:           end
Chris@1494:           next
Chris@1494:         end
Chris@1494:       end
Chris@1494:       strings << show_detail(detail, no_html, options)
Chris@1494:     end
Chris@1494:     values_by_field.each do |field, changes|
Chris@1494:       detail = JournalDetail.new(:property => 'cf', :prop_key => field.id.to_s)
Chris@1494:       detail.instance_variable_set "@custom_field", field
Chris@1494:       if changes[:added].any?
Chris@1494:         detail.value = changes[:added]
Chris@1494:         strings << show_detail(detail, no_html, options)
Chris@1494:       elsif changes[:deleted].any?
Chris@1494:         detail.old_value = changes[:deleted]
Chris@1494:         strings << show_detail(detail, no_html, options)
Chris@1494:       end
Chris@1494:     end
Chris@1494:     strings
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Returns the textual representation of a single journal detail
Chris@1494:   def show_detail(detail, no_html=false, options={})
Chris@1494:     multiple = false
Chris@1494:     case detail.property
Chris@1494:     when 'attr'
Chris@1494:       field = detail.prop_key.to_s.gsub(/\_id$/, "")
Chris@1494:       label = l(("field_" + field).to_sym)
Chris@1494:       case detail.prop_key
Chris@1494:       when 'due_date', 'start_date'
Chris@1494:         value = format_date(detail.value.to_date) if detail.value
Chris@1494:         old_value = format_date(detail.old_value.to_date) if detail.old_value
Chris@1494: 
Chris@1494:       when 'project_id', 'status_id', 'tracker_id', 'assigned_to_id',
Chris@1494:             'priority_id', 'category_id', 'fixed_version_id'
Chris@1494:         value = find_name_by_reflection(field, detail.value)
Chris@1494:         old_value = find_name_by_reflection(field, detail.old_value)
Chris@1494: 
Chris@1494:       when 'estimated_hours'
Chris@1494:         value = "%0.02f" % detail.value.to_f unless detail.value.blank?
Chris@1494:         old_value = "%0.02f" % detail.old_value.to_f unless detail.old_value.blank?
Chris@1494: 
Chris@1494:       when 'parent_id'
Chris@1494:         label = l(:field_parent_issue)
Chris@1494:         value = "##{detail.value}" unless detail.value.blank?
Chris@1494:         old_value = "##{detail.old_value}" unless detail.old_value.blank?
Chris@1494: 
Chris@1494:       when 'is_private'
Chris@1494:         value = l(detail.value == "0" ? :general_text_No : :general_text_Yes) unless detail.value.blank?
Chris@1494:         old_value = l(detail.old_value == "0" ? :general_text_No : :general_text_Yes) unless detail.old_value.blank?
Chris@1494:       end
Chris@1494:     when 'cf'
Chris@1494:       custom_field = detail.custom_field
Chris@1494:       if custom_field
Chris@1494:         multiple = custom_field.multiple?
Chris@1494:         label = custom_field.name
Chris@1494:         value = format_value(detail.value, custom_field.field_format) if detail.value
Chris@1494:         old_value = format_value(detail.old_value, custom_field.field_format) if detail.old_value
Chris@1494:       end
Chris@1494:     when 'attachment'
Chris@1494:       label = l(:label_attachment)
Chris@1494:     when 'relation'
Chris@1494:       if detail.value && !detail.old_value
Chris@1494:         rel_issue = Issue.visible.find_by_id(detail.value)
Chris@1494:         value = rel_issue.nil? ? "#{l(:label_issue)} ##{detail.value}" :
Chris@1494:                   (no_html ? rel_issue : link_to_issue(rel_issue, :only_path => options[:only_path]))
Chris@1494:       elsif detail.old_value && !detail.value
Chris@1494:         rel_issue = Issue.visible.find_by_id(detail.old_value)
Chris@1494:         old_value = rel_issue.nil? ? "#{l(:label_issue)} ##{detail.old_value}" :
Chris@1494:                           (no_html ? rel_issue : link_to_issue(rel_issue, :only_path => options[:only_path]))
Chris@1494:       end
Chris@1494:       label = l(detail.prop_key.to_sym)
Chris@1494:     end
Chris@1494:     call_hook(:helper_issues_show_detail_after_setting,
Chris@1494:               {:detail => detail, :label => label, :value => value, :old_value => old_value })
Chris@1494: 
Chris@1494:     label ||= detail.prop_key
Chris@1494:     value ||= detail.value
Chris@1494:     old_value ||= detail.old_value
Chris@1494: 
Chris@1494:     unless no_html
Chris@1494:       label = content_tag('strong', label)
Chris@1494:       old_value = content_tag("i", h(old_value)) if detail.old_value
Chris@1494:       if detail.old_value && detail.value.blank? && detail.property != 'relation'
Chris@1494:         old_value = content_tag("del", old_value)
Chris@1494:       end
Chris@1494:       if detail.property == 'attachment' && !value.blank? && atta = Attachment.find_by_id(detail.prop_key)
Chris@1494:         # Link to the attachment if it has not been removed
Chris@1494:         value = link_to_attachment(atta, :download => true, :only_path => options[:only_path])
Chris@1494:         if options[:only_path] != false && atta.is_text?
Chris@1494:           value += link_to(
Chris@1494:                        image_tag('magnifier.png'),
Chris@1494:                        :controller => 'attachments', :action => 'show',
Chris@1494:                        :id => atta, :filename => atta.filename
Chris@1494:                      )
Chris@1494:         end
Chris@1494:       else
Chris@1494:         value = content_tag("i", h(value)) if value
Chris@1494:       end
Chris@1494:     end
Chris@1494: 
Chris@1494:     if detail.property == 'attr' && detail.prop_key == 'description'
Chris@1494:       s = l(:text_journal_changed_no_detail, :label => label)
Chris@1494:       unless no_html
Chris@1494:         diff_link = link_to 'diff',
Chris@1494:           {:controller => 'journals', :action => 'diff', :id => detail.journal_id,
Chris@1494:            :detail_id => detail.id, :only_path => options[:only_path]},
Chris@1494:           :title => l(:label_view_diff)
Chris@1494:         s << " (#{ diff_link })"
Chris@1494:       end
Chris@1494:       s.html_safe
Chris@1494:     elsif detail.value.present?
Chris@1494:       case detail.property
Chris@1494:       when 'attr', 'cf'
Chris@1494:         if detail.old_value.present?
Chris@1494:           l(:text_journal_changed, :label => label, :old => old_value, :new => value).html_safe
Chris@1494:         elsif multiple
Chris@1494:           l(:text_journal_added, :label => label, :value => value).html_safe
Chris@1494:         else
Chris@1494:           l(:text_journal_set_to, :label => label, :value => value).html_safe
Chris@1494:         end
Chris@1494:       when 'attachment', 'relation'
Chris@1494:         l(:text_journal_added, :label => label, :value => value).html_safe
Chris@1494:       end
Chris@1494:     else
Chris@1494:       l(:text_journal_deleted, :label => label, :old => old_value).html_safe
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Find the name of an associated record stored in the field attribute
Chris@1494:   def find_name_by_reflection(field, id)
Chris@1494:     unless id.present?
Chris@1494:       return nil
Chris@1494:     end
Chris@1494:     association = Issue.reflect_on_association(field.to_sym)
Chris@1494:     if association
Chris@1494:       record = association.class_name.constantize.find_by_id(id)
Chris@1494:       if record
Chris@1494:         record.name.force_encoding('UTF-8') if record.name.respond_to?(:force_encoding)
Chris@1494:         return record.name
Chris@1494:       end
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Renders issue children recursively
Chris@1494:   def render_api_issue_children(issue, api)
Chris@1494:     return if issue.leaf?
Chris@1494:     api.array :children do
Chris@1494:       issue.children.each do |child|
Chris@1494:         api.issue(:id => child.id) do
Chris@1494:           api.tracker(:id => child.tracker_id, :name => child.tracker.name) unless child.tracker.nil?
Chris@1494:           api.subject child.subject
Chris@1494:           render_api_issue_children(child, api)
Chris@1494:         end
Chris@1494:       end
Chris@1494:     end
Chris@1494:   end
Chris@1494: end