Chris@245: # Redmine - project management software
Chris@245: # Copyright (C) 2006-2011  Jean-Philippe Lang
Chris@0: #
Chris@0: # This program is free software; you can redistribute it and/or
Chris@0: # modify it under the terms of the GNU General Public License
Chris@0: # as published by the Free Software Foundation; either version 2
Chris@0: # of the License, or (at your option) any later version.
Chris@441: #
Chris@0: # This program is distributed in the hope that it will be useful,
Chris@0: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@0: # GNU General Public License for more details.
Chris@441: #
Chris@0: # You should have received a copy of the GNU General Public License
Chris@0: # along with this program; if not, write to the Free Software
Chris@0: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@0: 
Chris@0: module IssuesHelper
Chris@0:   include ApplicationHelper
Chris@0: 
Chris@0:   def issue_list(issues, &block)
Chris@0:     ancestors = []
Chris@0:     issues.each do |issue|
Chris@0:       while (ancestors.any? && !issue.is_descendant_of?(ancestors.last))
Chris@0:         ancestors.pop
Chris@0:       end
Chris@0:       yield issue, ancestors.size
Chris@0:       ancestors << issue unless issue.leaf?
Chris@0:     end
Chris@0:   end
chris@22: 
chris@22:   # Renders a HTML/CSS tooltip
chris@22:   #
chris@22:   # To use, a trigger div is needed.  This is a div with the class of "tooltip"
chris@22:   # that contains this method wrapped in a span with the class of "tip"
chris@22:   #
chris@22:   #    <div class="tooltip"><%= link_to_issue(issue) %>
chris@22:   #      <span class="tip"><%= render_issue_tooltip(issue) %></span>
chris@22:   #    </div>
chris@22:   #
Chris@0:   def render_issue_tooltip(issue)
Chris@14:     @cached_label_status ||= l(:field_status)
Chris@0:     @cached_label_start_date ||= l(:field_start_date)
Chris@0:     @cached_label_due_date ||= l(:field_due_date)
Chris@0:     @cached_label_assigned_to ||= l(:field_assigned_to)
Chris@0:     @cached_label_priority ||= l(:field_priority)
chris@22:     @cached_label_project ||= l(:field_project)
chris@22: 
Chris@0:     link_to_issue(issue) + "<br /><br />" +
chris@22:       "<strong>#{@cached_label_project}</strong>: #{link_to_project(issue.project)}<br />" +
Chris@14:       "<strong>#{@cached_label_status}</strong>: #{issue.status.name}<br />" +
Chris@0:       "<strong>#{@cached_label_start_date}</strong>: #{format_date(issue.start_date)}<br />" +
Chris@0:       "<strong>#{@cached_label_due_date}</strong>: #{format_date(issue.due_date)}<br />" +
Chris@0:       "<strong>#{@cached_label_assigned_to}</strong>: #{issue.assigned_to}<br />" +
Chris@0:       "<strong>#{@cached_label_priority}</strong>: #{issue.priority.name}"
Chris@0:   end
Chris@441: 
Chris@441:   def issue_heading(issue)
Chris@441:     h("#{issue.tracker} ##{issue.id}")
Chris@441:   end
Chris@441: 
Chris@0:   def render_issue_subject_with_tree(issue)
Chris@0:     s = ''
Chris@441:     ancestors = issue.root? ? [] : issue.ancestors.visible.all
Chris@441:     ancestors.each do |ancestor|
Chris@0:       s << '<div>' + content_tag('p', link_to_issue(ancestor))
Chris@0:     end
Chris@441:     s << '<div>'
Chris@441:     subject = h(issue.subject)
Chris@441:     if issue.is_private?
Chris@441:       subject = content_tag('span', l(:field_is_private), :class => 'private') + ' ' + subject
Chris@441:     end
Chris@441:     s << content_tag('h3', subject)
Chris@441:     s << '</div>' * (ancestors.size + 1)
Chris@0:     s
Chris@0:   end
Chris@441: 
Chris@0:   def render_descendants_tree(issue)
Chris@0:     s = '<form><table class="list issues">'
Chris@441:     issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
Chris@0:       s << content_tag('tr',
Chris@0:              content_tag('td', check_box_tag("ids[]", child.id, false, :id => nil), :class => 'checkbox') +
Chris@0:              content_tag('td', link_to_issue(child, :truncate => 60), :class => 'subject') +
Chris@0:              content_tag('td', h(child.status)) +
Chris@0:              content_tag('td', link_to_user(child.assigned_to)) +
Chris@0:              content_tag('td', progress_bar(child.done_ratio, :width => '80px')),
Chris@0:              :class => "issue issue-#{child.id} hascontextmenu #{level > 0 ? "idnt idnt-#{level}" : nil}")
Chris@0:     end
Chris@0:     s << '</form></table>'
Chris@0:     s
Chris@0:   end
Chris@441: 
Chris@0:   def render_custom_fields_rows(issue)
Chris@0:     return if issue.custom_field_values.empty?
Chris@0:     ordered_values = []
Chris@0:     half = (issue.custom_field_values.size / 2.0).ceil
Chris@0:     half.times do |i|
Chris@0:       ordered_values << issue.custom_field_values[i]
Chris@0:       ordered_values << issue.custom_field_values[i + half]
Chris@0:     end
Chris@0:     s = "<tr>\n"
Chris@0:     n = 0
Chris@0:     ordered_values.compact.each do |value|
Chris@0:       s << "</tr>\n<tr>\n" if n > 0 && (n % 2) == 0
Chris@0:       s << "\t<th>#{ h(value.custom_field.name) }:</th><td>#{ simple_format_without_paragraph(h(show_value(value))) }</td>\n"
Chris@0:       n += 1
Chris@0:     end
Chris@0:     s << "</tr>\n"
Chris@0:     s
Chris@0:   end
Chris@441: 
Chris@441:   def issues_destroy_confirmation_message(issues)
Chris@441:     issues = [issues] unless issues.is_a?(Array)
Chris@441:     message = l(:text_issues_destroy_confirmation)
Chris@441:     descendant_count = issues.inject(0) {|memo, i| memo += (i.right - i.left - 1)/2}
Chris@441:     if descendant_count > 0
Chris@441:       issues.each do |issue|
Chris@441:         next if issue.root?
Chris@441:         issues.each do |other_issue|
Chris@441:           descendant_count -= 1 if issue.is_descendant_of?(other_issue)
Chris@441:         end
Chris@441:       end
Chris@441:       if descendant_count > 0
Chris@441:         message << "\n" + l(:text_issues_destroy_descendants_confirmation, :count => descendant_count)
Chris@441:       end
Chris@441:     end
Chris@441:     message
Chris@441:   end
Chris@441: 
Chris@0:   def sidebar_queries
Chris@0:     unless @sidebar_queries
Chris@0:       # User can see public queries and his own queries
Chris@0:       visible = ARCondition.new(["is_public = ? OR user_id = ?", true, (User.current.logged? ? User.current.id : 0)])
Chris@0:       # Project specific queries and global queries
Chris@0:       visible << (@project.nil? ? ["project_id IS NULL"] : ["project_id IS NULL OR project_id = ?", @project.id])
Chris@441:       @sidebar_queries = Query.find(:all,
Chris@245:                                     :select => 'id, name, is_public',
Chris@0:                                     :order => "name ASC",
Chris@0:                                     :conditions => visible.conditions)
Chris@0:     end
Chris@0:     @sidebar_queries
Chris@0:   end
Chris@0: 
Chris@245:   def query_links(title, queries)
Chris@245:     # links to #index on issues/show
Chris@245:     url_params = controller_name == 'issues' ? {:controller => 'issues', :action => 'index', :project_id => @project} : params
Chris@441: 
Chris@245:     content_tag('h3', title) +
Chris@245:       queries.collect {|query|
Chris@245:           link_to(h(query.name), url_params.merge(:query_id => query))
Chris@245:         }.join('<br />')
Chris@245:   end
Chris@441: 
Chris@245:   def render_sidebar_queries
Chris@245:     out = ''
Chris@245:     queries = sidebar_queries.select {|q| !q.is_public?}
Chris@245:     out << query_links(l(:label_my_queries), queries) if queries.any?
Chris@245:     queries = sidebar_queries.select {|q| q.is_public?}
Chris@245:     out << query_links(l(:label_query_plural), queries) if queries.any?
Chris@245:     out
Chris@245:   end
Chris@245: 
Chris@0:   def show_detail(detail, no_html=false)
Chris@0:     case detail.property
Chris@0:     when 'attr'
Chris@0:       field = detail.prop_key.to_s.gsub(/\_id$/, "")
Chris@0:       label = l(("field_" + field).to_sym)
Chris@0:       case
Chris@0:       when ['due_date', 'start_date'].include?(detail.prop_key)
Chris@0:         value = format_date(detail.value.to_date) if detail.value
Chris@0:         old_value = format_date(detail.old_value.to_date) if detail.old_value
Chris@0: 
Chris@0:       when ['project_id', 'status_id', 'tracker_id', 'assigned_to_id', 'priority_id', 'category_id', 'fixed_version_id'].include?(detail.prop_key)
Chris@0:         value = find_name_by_reflection(field, detail.value)
Chris@0:         old_value = find_name_by_reflection(field, detail.old_value)
Chris@0: 
Chris@0:       when detail.prop_key == 'estimated_hours'
Chris@0:         value = "%0.02f" % detail.value.to_f unless detail.value.blank?
Chris@0:         old_value = "%0.02f" % detail.old_value.to_f unless detail.old_value.blank?
Chris@0: 
Chris@0:       when detail.prop_key == 'parent_id'
Chris@0:         label = l(:field_parent_issue)
Chris@0:         value = "##{detail.value}" unless detail.value.blank?
Chris@0:         old_value = "##{detail.old_value}" unless detail.old_value.blank?
Chris@441: 
Chris@441:       when detail.prop_key == 'is_private'
Chris@441:         value = l(detail.value == "0" ? :general_text_No : :general_text_Yes) unless detail.value.blank?
Chris@441:         old_value = l(detail.old_value == "0" ? :general_text_No : :general_text_Yes) unless detail.old_value.blank?
Chris@0:       end
Chris@0:     when 'cf'
Chris@0:       custom_field = CustomField.find_by_id(detail.prop_key)
Chris@0:       if custom_field
Chris@0:         label = custom_field.name
Chris@0:         value = format_value(detail.value, custom_field.field_format) if detail.value
Chris@0:         old_value = format_value(detail.old_value, custom_field.field_format) if detail.old_value
Chris@0:       end
Chris@0:     when 'attachment'
Chris@0:       label = l(:label_attachment)
Chris@0:     end
Chris@0:     call_hook(:helper_issues_show_detail_after_setting, {:detail => detail, :label => label, :value => value, :old_value => old_value })
Chris@0: 
Chris@0:     label ||= detail.prop_key
Chris@0:     value ||= detail.value
Chris@0:     old_value ||= detail.old_value
Chris@441: 
Chris@0:     unless no_html
Chris@0:       label = content_tag('strong', label)
Chris@0:       old_value = content_tag("i", h(old_value)) if detail.old_value
Chris@0:       old_value = content_tag("strike", old_value) if detail.old_value and (!detail.value or detail.value.empty?)
Chris@0:       if detail.property == 'attachment' && !value.blank? && a = Attachment.find_by_id(detail.prop_key)
Chris@0:         # Link to the attachment if it has not been removed
Chris@0:         value = link_to_attachment(a)
Chris@0:       else
Chris@0:         value = content_tag("i", h(value)) if value
Chris@0:       end
Chris@0:     end
Chris@441: 
Chris@245:     if detail.property == 'attr' && detail.prop_key == 'description'
Chris@245:       s = l(:text_journal_changed_no_detail, :label => label)
Chris@245:       unless no_html
Chris@441:         diff_link = link_to 'diff',
Chris@245:           {:controller => 'journals', :action => 'diff', :id => detail.journal_id, :detail_id => detail.id},
Chris@245:           :title => l(:label_view_diff)
Chris@245:         s << " (#{ diff_link })"
Chris@245:       end
Chris@245:       s
Chris@245:     elsif !detail.value.blank?
Chris@0:       case detail.property
Chris@0:       when 'attr', 'cf'
Chris@0:         if !detail.old_value.blank?
Chris@0:           l(:text_journal_changed, :label => label, :old => old_value, :new => value)
Chris@0:         else
Chris@0:           l(:text_journal_set_to, :label => label, :value => value)
Chris@0:         end
Chris@0:       when 'attachment'
Chris@0:         l(:text_journal_added, :label => label, :value => value)
Chris@0:       end
Chris@0:     else
Chris@0:       l(:text_journal_deleted, :label => label, :old => old_value)
Chris@0:     end
Chris@0:   end
Chris@0: 
Chris@0:   # Find the name of an associated record stored in the field attribute
Chris@0:   def find_name_by_reflection(field, id)
Chris@0:     association = Issue.reflect_on_association(field.to_sym)
Chris@0:     if association
Chris@0:       record = association.class_name.constantize.find_by_id(id)
Chris@0:       return record.name if record
Chris@0:     end
Chris@0:   end
Chris@441: 
Chris@119:   # Renders issue children recursively
Chris@119:   def render_api_issue_children(issue, api)
Chris@119:     return if issue.leaf?
Chris@119:     api.array :children do
Chris@119:       issue.children.each do |child|
Chris@119:         api.issue(:id => child.id) do
Chris@119:           api.tracker(:id => child.tracker_id, :name => child.tracker.name) unless child.tracker.nil?
Chris@119:           api.subject child.subject
Chris@119:           render_api_issue_children(child, api)
Chris@119:         end
Chris@119:       end
Chris@119:     end
Chris@119:   end
Chris@441: 
Chris@0:   def issues_to_csv(issues, project = nil)
Chris@441:     ic = Iconv.new(l(:general_csv_encoding), 'UTF-8')
Chris@0:     decimal_separator = l(:general_csv_decimal_separator)
Chris@0:     export = FCSV.generate(:col_sep => l(:general_csv_separator)) do |csv|
Chris@0:       # csv header fields
Chris@0:       headers = [ "#",
Chris@441:                   l(:field_status),
Chris@0:                   l(:field_project),
Chris@0:                   l(:field_tracker),
Chris@0:                   l(:field_priority),
Chris@0:                   l(:field_subject),
Chris@0:                   l(:field_assigned_to),
Chris@0:                   l(:field_category),
Chris@0:                   l(:field_fixed_version),
Chris@0:                   l(:field_author),
Chris@0:                   l(:field_start_date),
Chris@0:                   l(:field_due_date),
Chris@0:                   l(:field_done_ratio),
Chris@0:                   l(:field_estimated_hours),
Chris@0:                   l(:field_parent_issue),
Chris@0:                   l(:field_created_on),
Chris@0:                   l(:field_updated_on)
Chris@0:                   ]
Chris@0:       # Export project custom fields if project is given
Chris@0:       # otherwise export custom fields marked as "For all projects"
Chris@0:       custom_fields = project.nil? ? IssueCustomField.for_all : project.all_issue_custom_fields
Chris@0:       custom_fields.each {|f| headers << f.name}
Chris@0:       # Description in the last column
Chris@0:       headers << l(:field_description)
Chris@0:       csv << headers.collect {|c| begin; ic.iconv(c.to_s); rescue; c.to_s; end }
Chris@0:       # csv lines
Chris@0:       issues.each do |issue|
Chris@0:         fields = [issue.id,
Chris@441:                   issue.status.name,
Chris@0:                   issue.project.name,
Chris@441:                   issue.tracker.name,
Chris@0:                   issue.priority.name,
Chris@0:                   issue.subject,
Chris@0:                   issue.assigned_to,
Chris@0:                   issue.category,
Chris@0:                   issue.fixed_version,
Chris@0:                   issue.author.name,
Chris@0:                   format_date(issue.start_date),
Chris@0:                   format_date(issue.due_date),
Chris@0:                   issue.done_ratio,
Chris@0:                   issue.estimated_hours.to_s.gsub('.', decimal_separator),
Chris@0:                   issue.parent_id,
Chris@441:                   format_time(issue.created_on),
Chris@0:                   format_time(issue.updated_on)
Chris@0:                   ]
Chris@0:         custom_fields.each {|f| fields << show_value(issue.custom_value_for(f)) }
Chris@0:         fields << issue.description
Chris@0:         csv << fields.collect {|c| begin; ic.iconv(c.to_s); rescue; c.to_s; end }
Chris@0:       end
Chris@0:     end
Chris@0:     export
Chris@0:   end
Chris@0: end