Advertisement
Guest User

Untitled

a guest
Nov 21st, 2017
89
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
Ruby 19.08 KB | None | 0 0
  1. # encoding: utf-8
  2. #
  3. # Redmine - project management software
  4. # Copyright (C) 2006-2016  Jean-Philippe Lang
  5. #
  6. # This program is free software; you can redistribute it and/or
  7. # modify it under the terms of the GNU General Public License
  8. # as published by the Free Software Foundation; either version 2
  9. # of the License, or (at your option) any later version.
  10. #
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. # GNU General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU General Public License
  17. # along with this program; if not, write to the Free Software
  18. # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19.  
  20. module IssuesHelper
  21.   include ApplicationHelper
  22.   include Redmine::Export::PDF::IssuesPdfHelper
  23.  
  24.   def issue_list(issues, &block)
  25.     ancestors = []
  26.     issues.each do |issue|
  27.       while (ancestors.any? && !issue.is_descendant_of?(ancestors.last))
  28.         ancestors.pop
  29.       end
  30.       yield issue, ancestors.size
  31.       ancestors << issue unless issue.leaf?
  32.     end
  33.   end
  34.  
  35.   def grouped_issue_list(issues, query, issue_count_by_group, &block)
  36.     previous_group, first = false, true
  37.     totals_by_group = query.totalable_columns.inject({}) do |h, column|
  38.       h[column] = query.total_by_group_for(column)
  39.       h
  40.     end
  41.     issue_list(issues) do |issue, level|
  42.       group_name = group_count = nil
  43.       if query.grouped?
  44.         group = query.group_by_column.value(issue)
  45.         if first || group != previous_group
  46.           if group.blank? && group != false
  47.             group_name = "(#{l(:label_blank_value)})"
  48.           else
  49.             group_name = format_object(group)
  50.           end
  51.           group_name ||= ""
  52.           group_count = issue_count_by_group[group]
  53.           group_totals = totals_by_group.map {|column, t| total_tag(column, t[group] || 0)}.join(" ").html_safe
  54.         end
  55.       end
  56.       yield issue, level, group_name, group_count, group_totals
  57.       previous_group, first = group, false
  58.     end
  59.   end
  60.  
  61.   # Renders a HTML/CSS tooltip
  62.   #
  63.   # To use, a trigger div is needed.  This is a div with the class of "tooltip"
  64.   # that contains this method wrapped in a span with the class of "tip"
  65.   #
  66.   #    <div class="tooltip"><%= link_to_issue(issue) %>
  67.   #      <span class="tip"><%= render_issue_tooltip(issue) %></span>
  68.   #    </div>
  69.   #
  70.   def render_issue_tooltip(issue)
  71.     @cached_label_status ||= l(:field_status)
  72.     @cached_label_start_date ||= l(:field_start_date)
  73.     @cached_label_due_date ||= l(:field_due_date)
  74.     @cached_label_assigned_to ||= l(:field_assigned_to)
  75.     @cached_label_priority ||= l(:field_priority)
  76.     @cached_label_project ||= l(:field_project)
  77.  
  78.     link_to_issue(issue) + "<br /><br />".html_safe +
  79.       "<strong>#{@cached_label_project}</strong>: #{link_to_project(issue.project)}<br />".html_safe +
  80.       "<strong>#{@cached_label_status}</strong>: #{h(issue.status.name)}<br />".html_safe +
  81.       "<strong>#{@cached_label_start_date}</strong>: #{format_date(issue.start_date)}<br />".html_safe +
  82.       "<strong>#{@cached_label_due_date}</strong>: #{format_date(issue.due_date)}<br />".html_safe +
  83.       "<strong>#{@cached_label_assigned_to}</strong>: #{h(issue.assigned_to)}<br />".html_safe +
  84.       "<strong>#{@cached_label_priority}</strong>: #{h(issue.priority.name)}".html_safe
  85.   end
  86.  
  87.   def issue_heading(issue)
  88.     h("#{issue.tracker} ##{issue.id}")
  89.   end
  90.  
  91.   def render_issue_subject_with_tree(issue)
  92.     s = ''
  93.     ancestors = issue.root? ? [] : issue.ancestors.visible.to_a
  94.     ancestors.each do |ancestor|
  95.       s << '<div>' + content_tag('p', link_to_issue(ancestor, :project => (issue.project_id != ancestor.project_id)))
  96.     end
  97.     s << '<div>'
  98.     subject = h(issue.subject)
  99.     if issue.is_private?
  100.       subject = content_tag('span', l(:field_is_private), :class => 'private') + ' ' + subject
  101.     end
  102.     s << content_tag('h3', subject)
  103.     s << '</div>' * (ancestors.size + 1)
  104.     s.html_safe
  105.   end
  106.  
  107.   def render_descendants_tree(issue)
  108.     s = '<form><table class="list issues">'
  109.     issue_list(issue.descendants.visible.preload(:status, :priority, :tracker).sort_by(&:lft)) do |child, level|
  110.       css = "issue issue-#{child.id} hascontextmenu"
  111.       css << " idnt idnt-#{level}" if level > 0
  112.       s << content_tag('tr',
  113.              content_tag('td', check_box_tag("ids[]", child.id, false, :id => nil), :class => 'checkbox') +
  114.              content_tag('td', link_to_issue(child, :project => (issue.project_id != child.project_id)), :class => 'subject', :style => 'width: 50%') +
  115.              content_tag('td', h(child.status)) +
  116.              content_tag('td', link_to_user(child.assigned_to)) +
  117.              content_tag('td', child.disabled_core_fields.include?('done_ratio') ? '' : progress_bar(child.done_ratio)),
  118.              :class => css)
  119.     end
  120.     s << '</table></form>'
  121.     s.html_safe
  122.   end
  123.  
  124.   def issue_estimated_hours_details(issue)
  125.     if issue.total_estimated_hours.present?
  126.       if issue.total_estimated_hours == issue.estimated_hours
  127.         l_hours_short(issue.estimated_hours)
  128.       else
  129.         s = issue.estimated_hours.present? ? l_hours_short(issue.estimated_hours) : ""
  130.         s << " (#{l(:label_total)}: #{l_hours_short(issue.total_estimated_hours)})"
  131.         s.html_safe
  132.       end
  133.     end
  134.   end
  135.  
  136.   def issue_spent_hours_details(issue)
  137.     if issue.total_spent_hours > 0
  138.       if issue.total_spent_hours == issue.spent_hours
  139.         link_to(l_hours_short(issue.spent_hours), issue_time_entries_path(issue))
  140.       else
  141.         s = issue.spent_hours > 0 ? l_hours_short(issue.spent_hours) : ""
  142.         s << " (#{l(:label_total)}: #{link_to l_hours_short(issue.total_spent_hours), issue_time_entries_path(issue)})"
  143.         s.html_safe
  144.       end
  145.     end
  146.   end
  147.  
  148.   # Returns an array of error messages for bulk edited issues
  149.   def bulk_edit_error_messages(issues)
  150.     messages = {}
  151.     issues.each do |issue|
  152.       issue.errors.full_messages.each do |message|
  153.         messages[message] ||= []
  154.         messages[message] << issue
  155.       end
  156.     end
  157.     messages.map { |message, issues|
  158.       "#{message}: " + issues.map {|i| "##{i.id}"}.join(', ')
  159.     }
  160.  end
  161.  
  162.   # Returns a link for adding a new subtask to the given issue
  163.   def link_to_new_subtask(issue)
  164.     attrs = {
  165.       :tracker_id => issue.tracker,
  166.       :parent_issue_id => issue
  167.     }
  168.     link_to(l(:button_add), new_project_issue_path(issue.project, :issue => attrs))
  169.   end
  170.  
  171.   class IssueFieldsRows
  172.     include ActionView::Helpers::TagHelper
  173.  
  174.     def initialize
  175.       @left = []
  176.       @right = []
  177.     end
  178.  
  179.     def left(*args)
  180.       args.any? ? @left << cells(*args) : @left
  181.     end
  182.  
  183.     def right(*args)
  184.       args.any? ? @right << cells(*args) : @right
  185.     end
  186.  
  187.     def size
  188.       @left.size > @right.size ? @left.size : @right.size
  189.     end
  190.  
  191.     def to_html
  192.       content =
  193.         content_tag('div', @left.reduce(&:+), :class => 'splitcontentleft') +
  194.         content_tag('div', @right.reduce(&:+), :class => 'splitcontentleft')
  195.  
  196.       content_tag('div', content, :class => 'splitcontent')
  197.     end
  198.  
  199.     def cells(label, text, options={})
  200.       options[:class] = [options[:class] || "", 'attribute'].join(' ')
  201.       content_tag 'div',
  202.         content_tag('div', label + ":", :class => 'label') + content_tag('div', text, :class => 'value'),
  203.         options
  204.     end
  205.   end
  206.  
  207.   def issue_fields_rows
  208.     r = IssueFieldsRows.new
  209.     yield r
  210.     r.to_html
  211.   end
  212.  
  213.   def render_custom_fields_rows(issue)
  214.     values = issue.visible_custom_field_values
  215.     return if values.empty?
  216.     half = (values.size / 2.0).ceil
  217.     issue_fields_rows do |rows|
  218.       values.each_with_index do |value, i|
  219.         css = "cf_#{value.custom_field.id}"
  220.         m = (i < half ? :left : :right)
  221.         rows.send m, custom_field_name_tag(value.custom_field), show_value(value), :class => css
  222.       end
  223.     end
  224.   end
  225.  
  226.   # Returns the path for updating the issue form
  227.   # with project as the current project
  228.   def update_issue_form_path(project, issue)
  229.     options = {:format => 'js'}
  230.     if issue.new_record?
  231.       if project
  232.         new_project_issue_path(project, options)
  233.       else
  234.         new_issue_path(options)
  235.       end
  236.     else
  237.       edit_issue_path(issue, options)
  238.     end
  239.   end
  240.  
  241.   # Returns the number of descendants for an array of issues
  242.   def issues_descendant_count(issues)
  243.     ids = issues.reject(&:leaf?).map {|issue| issue.descendants.ids}.flatten.uniq
  244.     ids -= issues.map(&:id)
  245.     ids.size
  246.   end
  247.  
  248.   def issues_destroy_confirmation_message(issues)
  249.     issues = [issues] unless issues.is_a?(Array)
  250.     message = l(:text_issues_destroy_confirmation)
  251.  
  252.     descendant_count = issues_descendant_count(issues)
  253.     if descendant_count > 0
  254.       message << "\n" + l(:text_issues_destroy_descendants_confirmation, :count => descendant_count)
  255.     end
  256.     message
  257.   end
  258.  
  259.   # Returns an array of users that are proposed as watchers
  260.   # on the new issue form
  261.   def users_for_new_issue_watchers(issue)
  262.     users = issue.watcher_users
  263.     if issue.project.users.count <= 20
  264.       users = (users + issue.project.users.sort).uniq
  265.     end
  266.     users
  267.   end
  268.  
  269.   def sidebar_queries
  270.     unless @sidebar_queries
  271.       @sidebar_queries = IssueQuery.visible.
  272.         order("#{Query.table_name}.name ASC").
  273.         # Project specific queries and global queries
  274.         where(@project.nil? ? ["project_id IS NULL"] : ["project_id IS NULL OR project_id = ?", @project.id]).
  275.         to_a
  276.     end
  277.     @sidebar_queries
  278.   end
  279.  
  280.   def query_links(title, queries, counts)
  281.     return '' if queries.empty?
  282.     # links to #index on issues/show
  283.     url_params = controller_name == 'issues' ? {:controller => 'issues', :action => 'index', :project_id => @project} : params
  284.  
  285.     content_tag('h3', title) + "\n" +
  286.       content_tag('ul',
  287.         queries.collect {|query|
  288.             link_name = query.name
  289.             link_name << " (#{counts[query.id]})"
  290.             css = 'query'
  291.             css << ' selected' if query == @query
  292.             content_tag('li', link_to(link_name, url_params.merge(:query_id => query), :class => css))
  293.           }.join("\n").html_safe,
  294.         :class => 'queries'
  295.       ) + "\n"
  296.   end
  297.  
  298.   def render_sidebar_queries
  299.     queries =
  300.     private_query_issues_counts = sidebar_issue_count_by_query(sidebar_queries.select(&:is_private?))
  301.     public_query_issues_counts = sidebar_issue_count_by_query(sidebar_queries.reject(&:is_private?))
  302.     out = ''.html_safe
  303.     out << query_links(l(:label_my_queries), sidebar_queries.select(&:is_private?), private_query_issues_counts)
  304.     out << query_links(l(:label_query_plural), sidebar_queries.reject(&:is_private?), public_query_issues_counts)
  305.     out
  306.   end
  307.  
  308.   def email_issue_attributes(issue, user)
  309.     items = []
  310.     %w(author status priority assigned_to category fixed_version).each do |attribute|
  311.       unless issue.disabled_core_fields.include?(attribute+"_id")
  312.         items << "#{l("field_#{attribute}")}: #{issue.send attribute}"
  313.       end
  314.     end
  315.     issue.visible_custom_field_values(user).each do |value|
  316.       items << "#{value.custom_field.name}: #{show_value(value, false)}"
  317.     end
  318.     items
  319.   end
  320.  
  321.   def render_email_issue_attributes(issue, user, html=false)
  322.     items = email_issue_attributes(issue, user)
  323.     if html
  324.       content_tag('ul', items.map{|s| content_tag('li', s)}.join("\n").html_safe)
  325.     else
  326.       items.map{|s| "* #{s}"}.join("\n")
  327.     end
  328.   end
  329.  
  330.   # Returns the textual representation of a journal details
  331.   # as an array of strings
  332.   def details_to_strings(details, no_html=false, options={})
  333.     options[:only_path] = (options[:only_path] == false ? false : true)
  334.     strings = []
  335.     values_by_field = {}
  336.     details.each do |detail|
  337.       if detail.property == 'cf'
  338.         field = detail.custom_field
  339.         if field && field.multiple?
  340.           values_by_field[field] ||= {:added => [], :deleted => []}
  341.           if detail.old_value
  342.             values_by_field[field][:deleted] << detail.old_value
  343.           end
  344.           if detail.value
  345.             values_by_field[field][:added] << detail.value
  346.           end
  347.           next
  348.         end
  349.       end
  350.       strings << show_detail(detail, no_html, options)
  351.     end
  352.     if values_by_field.present?
  353.       multiple_values_detail = Struct.new(:property, :prop_key, :custom_field, :old_value, :value)
  354.       values_by_field.each do |field, changes|
  355.         if changes[:added].any?
  356.           detail = multiple_values_detail.new('cf', field.id.to_s, field)
  357.           detail.value = changes[:added]
  358.           strings << show_detail(detail, no_html, options)
  359.         end
  360.         if changes[:deleted].any?
  361.           detail = multiple_values_detail.new('cf', field.id.to_s, field)
  362.           detail.old_value = changes[:deleted]
  363.           strings << show_detail(detail, no_html, options)
  364.         end
  365.       end
  366.     end
  367.     strings
  368.   end
  369.  
  370.   # Returns the textual representation of a single journal detail
  371.   def show_detail(detail, no_html=false, options={})
  372.     multiple = false
  373.     show_diff = false
  374.  
  375.     case detail.property
  376.     when 'attr'
  377.       field = detail.prop_key.to_s.gsub(/\_id$/, "")
  378.       label = l(("field_" + field).to_sym)
  379.       case detail.prop_key
  380.       when 'due_date', 'start_date'
  381.         value = format_date(detail.value.to_date) if detail.value
  382.         old_value = format_date(detail.old_value.to_date) if detail.old_value
  383.  
  384.       when 'project_id', 'status_id', 'tracker_id', 'assigned_to_id',
  385.             'priority_id', 'category_id', 'fixed_version_id'
  386.         value = find_name_by_reflection(field, detail.value)
  387.         old_value = find_name_by_reflection(field, detail.old_value)
  388.  
  389.       when 'estimated_hours'
  390.         value = "%0.02f" % detail.value.to_f unless detail.value.blank?
  391.         old_value = "%0.02f" % detail.old_value.to_f unless detail.old_value.blank?
  392.  
  393.       when 'parent_id'
  394.         label = l(:field_parent_issue)
  395.         value = "##{detail.value}" unless detail.value.blank?
  396.         old_value = "##{detail.old_value}" unless detail.old_value.blank?
  397.  
  398.       when 'is_private'
  399.         value = l(detail.value == "0" ? :general_text_No : :general_text_Yes) unless detail.value.blank?
  400.         old_value = l(detail.old_value == "0" ? :general_text_No : :general_text_Yes) unless detail.old_value.blank?
  401.  
  402.       when 'description'
  403.         show_diff = true
  404.       end
  405.     when 'cf'
  406.       custom_field = detail.custom_field
  407.       if custom_field
  408.         label = custom_field.name
  409.         if custom_field.format.class.change_as_diff
  410.           show_diff = true
  411.         else
  412.           multiple = custom_field.multiple?
  413.           value = format_value(detail.value, custom_field) if detail.value
  414.           old_value = format_value(detail.old_value, custom_field) if detail.old_value
  415.         end
  416.       end
  417.     when 'attachment'
  418.       label = l(:label_attachment)
  419.     when 'relation'
  420.       if detail.value && !detail.old_value
  421.         rel_issue = Issue.visible.find_by_id(detail.value)
  422.         value = rel_issue.nil? ? "#{l(:label_issue)} ##{detail.value}" :
  423.                   (no_html ? rel_issue : link_to_issue(rel_issue, :only_path => options[:only_path]))
  424.       elsif detail.old_value && !detail.value
  425.         rel_issue = Issue.visible.find_by_id(detail.old_value)
  426.         old_value = rel_issue.nil? ? "#{l(:label_issue)} ##{detail.old_value}" :
  427.                           (no_html ? rel_issue : link_to_issue(rel_issue, :only_path => options[:only_path]))
  428.       end
  429.       relation_type = IssueRelation::TYPES[detail.prop_key]
  430.       label = l(relation_type[:name]) if relation_type
  431.     end
  432.     call_hook(:helper_issues_show_detail_after_setting,
  433.               {:detail => detail, :label => label, :value => value, :old_value => old_value })
  434.  
  435.     label ||= detail.prop_key
  436.     value ||= detail.value
  437.     old_value ||= detail.old_value
  438.  
  439.     unless no_html
  440.       label = content_tag('strong', label)
  441.       old_value = content_tag("i", h(old_value)) if detail.old_value
  442.       if detail.old_value && detail.value.blank? && detail.property != 'relation'
  443.         old_value = content_tag("del", old_value)
  444.       end
  445.       if detail.property == 'attachment' && value.present? &&
  446.           atta = detail.journal.journalized.attachments.detect {|a| a.id == detail.prop_key.to_i}
  447.         # Link to the attachment if it has not been removed
  448.         value = link_to_attachment(atta, :download => true, :only_path => options[:only_path])
  449.         if options[:only_path] != false && atta.is_text?
  450.           value += link_to(
  451.                        image_tag('magnifier.png'),
  452.                        :controller => 'attachments', :action => 'show',
  453.                        :id => atta, :filename => atta.filename
  454.                      )
  455.         end
  456.       else
  457.         value = content_tag("i", h(value)) if value
  458.       end
  459.     end
  460.  
  461.     if show_diff
  462.       s = l(:text_journal_changed_no_detail, :label => label)
  463.       unless no_html
  464.         diff_link = link_to 'diff',
  465.           {:controller => 'journals', :action => 'diff', :id => detail.journal_id,
  466.            :detail_id => detail.id, :only_path => options[:only_path]},
  467.           :title => l(:label_view_diff)
  468.         s << " (#{ diff_link })"
  469.       end
  470.       s.html_safe
  471.     elsif detail.value.present?
  472.       case detail.property
  473.       when 'attr', 'cf'
  474.         if detail.old_value.present?
  475.           l(:text_journal_changed, :label => label, :old => old_value, :new => value).html_safe
  476.         elsif multiple
  477.           l(:text_journal_added, :label => label, :value => value).html_safe
  478.         else
  479.           l(:text_journal_set_to, :label => label, :value => value).html_safe
  480.         end
  481.       when 'attachment', 'relation'
  482.         l(:text_journal_added, :label => label, :value => value).html_safe
  483.       end
  484.     else
  485.       l(:text_journal_deleted, :label => label, :old => old_value).html_safe
  486.     end
  487.   end
  488.  
  489.   # Find the name of an associated record stored in the field attribute
  490.   def find_name_by_reflection(field, id)
  491.     unless id.present?
  492.       return nil
  493.     end
  494.     @detail_value_name_by_reflection ||= Hash.new do |hash, key|
  495.       association = Issue.reflect_on_association(key.first.to_sym)
  496.       name = nil
  497.       if association
  498.         record = association.klass.find_by_id(key.last)
  499.         if record
  500.           name = record.name.force_encoding('UTF-8')
  501.         end
  502.       end
  503.       hash[key] = name
  504.     end
  505.     @detail_value_name_by_reflection[[field, id]]
  506.   end
  507.  
  508.   # Renders issue children recursively
  509.   def render_api_issue_children(issue, api)
  510.     return if issue.leaf?
  511.     api.array :children do
  512.       issue.children.each do |child|
  513.         api.issue(:id => child.id) do
  514.           api.tracker(:id => child.tracker_id, :name => child.tracker.name) unless child.tracker.nil?
  515.           api.subject child.subject
  516.           render_api_issue_children(child, api)
  517.         end
  518.       end
  519.     end
  520.   end
  521.  
  522.   def sidebar_issue_count_by_query(queries)
  523.     counts = {}
  524.     queries.each do |query|
  525.       counts[query.id] = query.issue_count.to_i
  526.     end
  527.     counts
  528.   end
  529. end
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement