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