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 Redmine
Chris@909:   # Class used to parse unified diffs
Chris@909:   class UnifiedDiff < Array
Chris@909:     attr_reader :diff_type
Chris@909: 
Chris@909:     def initialize(diff, options={})
Chris@909:       options.assert_valid_keys(:type, :max_lines)
Chris@909:       diff = diff.split("\n") if diff.is_a?(String)
Chris@909:       @diff_type = options[:type] || 'inline'
Chris@909:       lines = 0
Chris@909:       @truncated = false
Chris@909:       diff_table = DiffTable.new(@diff_type)
Chris@909:       diff.each do |line|
Chris@909:         line_encoding = nil
Chris@909:         if line.respond_to?(:force_encoding)
Chris@909:           line_encoding = line.encoding
Chris@909:           # TODO: UTF-16 and Japanese CP932 which is imcompatible with ASCII
Chris@909:           #       In Japan, diffrence between file path encoding
Chris@909:           #       and file contents encoding is popular.
Chris@909:           line.force_encoding('ASCII-8BIT')
Chris@909:         end
Chris@909:         unless diff_table.add_line line
Chris@909:           line.force_encoding(line_encoding) if line_encoding
Chris@909:           self << diff_table if diff_table.length > 0
Chris@909:           diff_table = DiffTable.new(diff_type)
Chris@909:         end
Chris@909:         lines += 1
Chris@909:         if options[:max_lines] && lines > options[:max_lines]
Chris@909:           @truncated = true
Chris@909:           break
Chris@909:         end
Chris@909:       end
Chris@909:       self << diff_table unless diff_table.empty?
Chris@909:       self
Chris@909:     end
Chris@909: 
Chris@909:     def truncated?; @truncated; end
Chris@909:   end
Chris@909: 
Chris@909:   # Class that represents a file diff
Chris@909:   class DiffTable < Array
Chris@909:     attr_reader :file_name
Chris@909: 
Chris@909:     # Initialize with a Diff file and the type of Diff View
Chris@909:     # The type view must be inline or sbs (side_by_side)
Chris@909:     def initialize(type="inline")
Chris@909:       @parsing = false
Chris@909:       @added = 0
Chris@909:       @removed = 0
Chris@909:       @type = type
Chris@909:     end
Chris@909: 
Chris@909:     # Function for add a line of this Diff
Chris@909:     # Returns false when the diff ends
Chris@909:     def add_line(line)
Chris@909:       unless @parsing
Chris@909:         if line =~ /^(---|\+\+\+) (.*)$/
Chris@909:           @file_name = $2
Chris@909:         elsif line =~ /^@@ (\+|\-)(\d+)(,\d+)? (\+|\-)(\d+)(,\d+)? @@/
Chris@909:           @line_num_l = $2.to_i
Chris@909:           @line_num_r = $5.to_i
Chris@909:           @parsing = true
Chris@909:         end
Chris@909:       else
Chris@909:         if line =~ /^[^\+\-\s@\\]/
Chris@909:           @parsing = false
Chris@909:           return false
Chris@909:         elsif line =~ /^@@ (\+|\-)(\d+)(,\d+)? (\+|\-)(\d+)(,\d+)? @@/
Chris@909:           @line_num_l = $2.to_i
Chris@909:           @line_num_r = $5.to_i
Chris@909:         else
Chris@909:           parse_line(line, @type)
Chris@909:         end
Chris@909:       end
Chris@909:       return true
Chris@909:     end
Chris@909: 
Chris@909:     def each_line
Chris@909:       prev_line_left, prev_line_right = nil, nil
Chris@909:       each do |line|
Chris@909:         spacing = prev_line_left && prev_line_right && (line.nb_line_left != prev_line_left+1) && (line.nb_line_right != prev_line_right+1)
Chris@909:         yield spacing, line
Chris@909:         prev_line_left = line.nb_line_left.to_i if line.nb_line_left.to_i > 0
Chris@909:         prev_line_right = line.nb_line_right.to_i if line.nb_line_right.to_i > 0
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     def inspect
Chris@909:       puts '### DIFF TABLE ###'
Chris@909:       puts "file : #{file_name}"
Chris@909:       self.each do |d|
Chris@909:         d.inspect
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     private
Chris@909: 
Chris@909:     # Escape the HTML for the diff
Chris@909:     def escapeHTML(line)
Chris@909:         CGI.escapeHTML(line)
Chris@909:     end
Chris@909: 
Chris@909:     def diff_for_added_line
Chris@909:       if @type == 'sbs' && @removed > 0 && @added < @removed
Chris@909:         self[-(@removed - @added)]
Chris@909:       else
Chris@909:         diff = Diff.new
Chris@909:         self << diff
Chris@909:         diff
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     def parse_line(line, type="inline")
Chris@909:       if line[0, 1] == "+"
Chris@909:         diff = diff_for_added_line
Chris@909:         diff.line_right = escapeHTML line[1..-1]
Chris@909:         diff.nb_line_right = @line_num_r
Chris@909:         diff.type_diff_right = 'diff_in'
Chris@909:         @line_num_r += 1
Chris@909:         @added += 1
Chris@909:         true
Chris@909:       elsif line[0, 1] == "-"
Chris@909:         diff = Diff.new
Chris@909:         diff.line_left = escapeHTML line[1..-1]
Chris@909:         diff.nb_line_left = @line_num_l
Chris@909:         diff.type_diff_left = 'diff_out'
Chris@909:         self << diff
Chris@909:         @line_num_l += 1
Chris@909:         @removed += 1
Chris@909:         true
Chris@909:       else
Chris@909:         write_offsets
Chris@909:         if line[0, 1] =~ /\s/
Chris@909:           diff = Diff.new
Chris@909:           diff.line_right = escapeHTML line[1..-1]
Chris@909:           diff.nb_line_right = @line_num_r
Chris@909:           diff.line_left = escapeHTML line[1..-1]
Chris@909:           diff.nb_line_left = @line_num_l
Chris@909:           self << diff
Chris@909:           @line_num_l += 1
Chris@909:           @line_num_r += 1
Chris@909:           true
Chris@909:         elsif line[0, 1] = "\\"
Chris@909:           true
Chris@909:         else
Chris@909:           false
Chris@909:         end
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     def write_offsets
Chris@909:       if @added > 0 && @added == @removed
Chris@909:         @added.times do |i|
Chris@909:           line = self[-(1 + i)]
Chris@909:           removed = (@type == 'sbs') ? line : self[-(1 + @added + i)]
Chris@909:           offsets = offsets(removed.line_left, line.line_right)
Chris@909:           removed.offsets = line.offsets = offsets
Chris@909:         end
Chris@909:       end
Chris@909:       @added = 0
Chris@909:       @removed = 0
Chris@909:     end
Chris@909: 
Chris@909:     def offsets(line_left, line_right)
Chris@909:       if line_left.present? && line_right.present? && line_left != line_right
Chris@909:         max = [line_left.size, line_right.size].min
Chris@909:         starting = 0
Chris@909:         while starting < max && line_left[starting] == line_right[starting]
Chris@909:           starting += 1
Chris@909:         end
Chris@909:         ending = -1
Chris@909:         while ending >= -(max - starting) && line_left[ending] == line_right[ending]
Chris@909:           ending -= 1
Chris@909:         end
Chris@909:         unless starting == 0 && ending == -1
Chris@909:           [starting, ending]
Chris@909:         end
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   # A line of diff
Chris@909:   class Diff
Chris@909:     attr_accessor :nb_line_left
Chris@909:     attr_accessor :line_left
Chris@909:     attr_accessor :nb_line_right
Chris@909:     attr_accessor :line_right
Chris@909:     attr_accessor :type_diff_right
Chris@909:     attr_accessor :type_diff_left
Chris@909:     attr_accessor :offsets
Chris@909: 
Chris@909:     def initialize()
Chris@909:       self.nb_line_left = ''
Chris@909:       self.nb_line_right = ''
Chris@909:       self.line_left = ''
Chris@909:       self.line_right = ''
Chris@909:       self.type_diff_right = ''
Chris@909:       self.type_diff_left = ''
Chris@909:     end
Chris@909: 
Chris@909:     def type_diff
Chris@909:       type_diff_right == 'diff_in' ? type_diff_right : type_diff_left
Chris@909:     end
Chris@909: 
Chris@909:     def line
Chris@909:       type_diff_right == 'diff_in' ? line_right : line_left
Chris@909:     end
Chris@909: 
Chris@909:     def html_line_left
Chris@909:       if offsets
Chris@909:         line_left.dup.insert(offsets.first, '<span>').insert(offsets.last, '</span>')
Chris@909:       else
Chris@909:         line_left
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     def html_line_right
Chris@909:       if offsets
Chris@909:         line_right.dup.insert(offsets.first, '<span>').insert(offsets.last, '</span>')
Chris@909:       else
Chris@909:         line_right
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     def html_line
Chris@909:       if offsets
Chris@909:         line.dup.insert(offsets.first, '<span>').insert(offsets.last, '</span>')
Chris@909:       else
Chris@909:         line
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@909:     def inspect
Chris@909:       puts '### Start Line Diff ###'
Chris@909:       puts self.nb_line_left
Chris@909:       puts self.line_left
Chris@909:       puts self.nb_line_right
Chris@909:       puts self.line_right
Chris@909:     end
Chris@909:   end
Chris@909: end