jro_apps/redmine Commit - r1767:d611339baaf3

Fixes error with CVS+Postgresql and non-UTF8 commit logs (#917, #1659)....

Jean-Philippe Lang -

r1767:d611339baaf3

parent child

Context file:

r1767:d611339baaf3

Collapse all files

app/models/changeset.rb +7 -2

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'iconv'
             class Changeset < ActiveRecord::Base
               belongs_to :repository
               has_many :changes, :dependent => :delete_all
               has_and_belongs_to_many :issues
               acts_as_event :title => Proc.new {|o| "#{l(:label_revision)} #{o.revision}" + (o.comments.blank? ? '' : (': ' + o.comments))},
                             :description => :comments,
                             :datetime => :committed_on,
                             :author => :committer,
                             :url => Proc.new {|o| {:controller => 'repositories', :action => 'revision', :id => o.repository.project_id, :rev => o.revision}}
               acts_as_searchable :columns => 'comments',
                                  :include => {:repository => :project},
                                  :project_key => "#{Repository.table_name}.project_id",
                                  :date_column => 'committed_on'
               acts_as_activity_provider :timestamp => "#{table_name}.committed_on",
                                         :find_options => {:include => {:repository => :project}}
               validates_presence_of :repository_id, :revision, :committed_on, :commit_date
               validates_uniqueness_of :revision, :scope => :repository_id
               validates_uniqueness_of :scmid, :scope => :repository_id, :allow_nil => true
               def revision=(r)
                 write_attribute :revision, (r.nil? ? nil : r.to_s)
               end
               def comments=(comment)
-                write_attribute(:comments, to_utf8(comment.to_s.strip))
+                write_attribute(:comments, Changeset.normalize_comments(comment))
               end
               def committed_on=(date)
                 self.commit_date = date
                 super
               end
               def project
                 repository.project
               end
               def after_create
                 scan_comment_for_issue_ids
               end
               require 'pp'
               def scan_comment_for_issue_ids
                 return if comments.blank?
                 # keywords used to reference issues
                 ref_keywords = Setting.commit_ref_keywords.downcase.split(",").collect(&:strip)
                 # keywords used to fix issues
                 fix_keywords = Setting.commit_fix_keywords.downcase.split(",").collect(&:strip)
                 # status and optional done ratio applied
                 fix_status = IssueStatus.find_by_id(Setting.commit_fix_status_id)
                 done_ratio = Setting.commit_fix_done_ratio.blank? ? nil : Setting.commit_fix_done_ratio.to_i
                 kw_regexp = (ref_keywords + fix_keywords).collect{|kw| Regexp.escape(kw)}.join("|")
                 return if kw_regexp.blank?
                 referenced_issues = []
                 if ref_keywords.delete('*')
                   # find any issue ID in the comments
                   target_issue_ids = []
                   comments.scan(%r{([\s\(,-]|^)#(\d+)(?=[[:punct:]]|\s|<|$)}).each { |m| target_issue_ids << m[1] }
                   referenced_issues += repository.project.issues.find_all_by_id(target_issue_ids)
                 end
                 comments.scan(Regexp.new("(#{kw_regexp})[\s:]+(([\s,;&]*#?\\d+)+)", Regexp::IGNORECASE)).each do |match|
                   action = match[0]
                   target_issue_ids = match[1].scan(/\d+/)
                   target_issues = repository.project.issues.find_all_by_id(target_issue_ids)
                   if fix_status && fix_keywords.include?(action.downcase)
                     # update status of issues
                     logger.debug "Issues fixed by changeset #{self.revision}: #{issue_ids.join(', ')}." if logger && logger.debug?
                     target_issues.each do |issue|
                       # the issue may have been updated by the closure of another one (eg. duplicate)
                       issue.reload
                       # don't change the status is the issue is closed
                       next if issue.status.is_closed?
                       user = committer_user || User.anonymous
                       csettext = "r#{self.revision}"
                       if self.scmid && (! (csettext =~ /^r[0-9]+$/))
                         csettext = "commit:\"#{self.scmid}\""
                       end
                       journal = issue.init_journal(user, l(:text_status_changed_by_changeset, csettext))
                       issue.status = fix_status
                       issue.done_ratio = done_ratio if done_ratio
                       issue.save
                       Mailer.deliver_issue_edit(journal) if Setting.notified_events.include?('issue_updated')
                     end
                   end
                   referenced_issues += target_issues
                 end
                 self.issues = referenced_issues.uniq
               end
               # Returns the Redmine User corresponding to the committer
               def committer_user
                 if committer && committer.strip =~ /^([^<]+)(<(.*)>)?$/
                   username, email = $1.strip, $3
                   u = User.find_by_login(username)
                   u ||= User.find_by_mail(email) unless email.blank?
                   u
                 end
               end
               # Returns the previous changeset
               def previous
                 @previous ||= Changeset.find(:first, :conditions => ['id < ? AND repository_id = ?', self.id, self.repository_id], :order => 'id DESC')
               end
               # Returns the next changeset
               def next
                 @next ||= Changeset.find(:first, :conditions => ['id > ? AND repository_id = ?', self.id, self.repository_id], :order => 'id ASC')
               end
+              # Strips and reencodes a commit log before insertion into the database
+              def self.normalize_comments(str)
+                to_utf8(str.to_s.strip)
+              end
               private
-              def to_utf8(str)
+              def self.to_utf8(str)
                 return str if /\A[\r\n\t\x20-\x7e]*\Z/n.match(str) # for us-ascii
                 encoding = Setting.commit_logs_encoding.to_s.strip
                 unless encoding.blank? || encoding == 'UTF-8'
                   begin
                     return Iconv.conv('UTF-8', encoding, str)
                   rescue Iconv::Failure
                     # do nothing here
                   end
                 end
                 str
               end
             end

app/models/repository/cvs.rb +1 -1

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'redmine/scm/adapters/cvs_adapter'
             require 'digest/sha1'
             class Repository::Cvs < Repository
               validates_presence_of :url, :root_url
               def scm_adapter
                 Redmine::Scm::Adapters::CvsAdapter
               end
               def self.scm_name
                 'CVS'
               end
               def entry(path=nil, identifier=nil)
                 rev = identifier.nil? ? nil : changesets.find_by_revision(identifier)
                 scm.entry(path, rev.nil? ? nil : rev.committed_on)
               end
               def entries(path=nil, identifier=nil)
                 rev = identifier.nil? ? nil : changesets.find_by_revision(identifier)
                 entries = scm.entries(path, rev.nil? ? nil : rev.committed_on)
                 if entries
                   entries.each() do |entry|
                     unless entry.lastrev.nil? || entry.lastrev.identifier
                       change=changes.find_by_revision_and_path( entry.lastrev.revision, scm.with_leading_slash(entry.path) )
                       if change
                         entry.lastrev.identifier=change.changeset.revision
                         entry.lastrev.author=change.changeset.committer
                         entry.lastrev.revision=change.revision
                         entry.lastrev.branch=change.branch
                       end
                     end
                   end
                 end
                 entries
               end
               def cat(path, identifier=nil)
                 rev = identifier.nil? ? nil : changesets.find_by_revision(identifier)
                 scm.cat(path, rev.nil? ? nil : rev.committed_on)
               end
               def diff(path, rev, rev_to)
                 #convert rev to revision. CVS can't handle changesets here
                 diff=[]
                 changeset_from=changesets.find_by_revision(rev)
                 if rev_to.to_i > 0
                   changeset_to=changesets.find_by_revision(rev_to)
                 end
                 changeset_from.changes.each() do |change_from|
                   revision_from=nil
                   revision_to=nil
                   revision_from=change_from.revision if path.nil? || (change_from.path.starts_with? scm.with_leading_slash(path))
                   if revision_from
                     if changeset_to
                       changeset_to.changes.each() do |change_to|
                         revision_to=change_to.revision if change_to.path==change_from.path
                       end
                     end
                     unless revision_to
                       revision_to=scm.get_previous_revision(revision_from)
                     end
                     file_diff = scm.diff(change_from.path, revision_from, revision_to)
                     diff = diff + file_diff unless file_diff.nil?
                   end
                 end
                 return diff
               end
               def fetch_changesets
                 # some nifty bits to introduce a commit-id with cvs
                 # natively cvs doesn't provide any kind of changesets, there is only a revision per file.
                 # we now take a guess using the author, the commitlog and the commit-date.
                 # last one is the next step to take. the commit-date is not equal for all
                 # commits in one changeset. cvs update the commit-date when the *,v file was touched. so
                 # we use a small delta here, to merge all changes belonging to _one_ changeset
                 time_delta=10.seconds
                 fetch_since = latest_changeset ? latest_changeset.committed_on : nil
                 transaction do
                   tmp_rev_num = 1
                   scm.revisions('', fetch_since, nil, :with_paths => true) do |revision|
                     # only add the change to the database, if it doen't exists. the cvs log
                     # is not exclusive at all.
                     unless changes.find_by_path_and_revision(scm.with_leading_slash(revision.paths[0][:path]), revision.paths[0][:revision])
                       revision
                       cs = changesets.find(:first, :conditions=>{
                         :committed_on=>revision.time-time_delta..revision.time+time_delta,
                         :committer=>revision.author,
-                        :comments=>revision.message
+                        :comments=>Changeset.normalize_comments(revision.message)
                       })
                       # create a new changeset....
                       unless cs
                         # we use a temporaray revision number here (just for inserting)
                         # later on, we calculate a continous positive number
                         latest = changesets.find(:first, :order => 'id DESC')
                         cs = Changeset.create(:repository => self,
                                               :revision => "_#{tmp_rev_num}",
                                               :committer => revision.author,
                                               :committed_on => revision.time,
                                               :comments => revision.message)
                         tmp_rev_num += 1
                       end
                       #convert CVS-File-States to internal Action-abbrevations
                       #default action is (M)odified
                       action="M"
                       if revision.paths[0][:action]=="Exp" && revision.paths[0][:revision]=="1.1"
                         action="A" #add-action always at first revision (= 1.1)
                       elsif revision.paths[0][:action]=="dead"
                         action="D" #dead-state is similar to Delete
                       end
                       Change.create(:changeset => cs,
                       :action => action,
                       :path => scm.with_leading_slash(revision.paths[0][:path]),
                       :revision => revision.paths[0][:revision],
                       :branch => revision.paths[0][:branch]
                       )
                     end
                   end
                   # Renumber new changesets in chronological order
                   changesets.find(:all, :order => 'committed_on ASC, id ASC', :conditions => "revision LIKE '_%'").each do |changeset|
                     changeset.update_attribute :revision, next_revision_number
                   end
                 end # transaction
               end
               private
               # Returns the next revision number to assign to a CVS changeset
               def next_revision_number
                 # Need to retrieve existing revision numbers to sort them as integers
                 @current_revision_number ||= (connection.select_values("SELECT revision FROM #{Changeset.table_name} WHERE repository_id = #{id} AND revision NOT LIKE '_%'").collect(&:to_i).max || 0)
                 @current_revision_number += 1
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages