Chris@0: # Redmine - project management software
Chris@0: # Copyright (C) 2006-2010  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@0: # 
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@0: # 
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: require 'iconv'
Chris@0: 
Chris@0: class Changeset < ActiveRecord::Base
Chris@0:   belongs_to :repository
Chris@0:   belongs_to :user
Chris@0:   has_many :changes, :dependent => :delete_all
Chris@0:   has_and_belongs_to_many :issues
Chris@0: 
Chris@3:   acts_as_event :title => Proc.new {|o| "#{l(:label_revision)} #{RepositoriesHelper.format_revision(o)}" + (o.short_comments.blank? ? '' : (': ' + o.short_comments))},
Chris@0:                 :description => :long_comments,
Chris@0:                 :datetime => :committed_on,
Chris@3:                 :url => Proc.new {|o| {:controller => 'repositories', :action => 'revision', :id => o.repository.project, :rev => o.identifier}}
Chris@0:                 
Chris@0:   acts_as_searchable :columns => 'comments',
Chris@0:                      :include => {:repository => :project},
Chris@0:                      :project_key => "#{Repository.table_name}.project_id",
Chris@0:                      :date_column => 'committed_on'
Chris@0:                      
Chris@0:   acts_as_activity_provider :timestamp => "#{table_name}.committed_on",
Chris@0:                             :author_key => :user_id,
Chris@0:                             :find_options => {:include => [:user, {:repository => :project}]}
Chris@0:   
Chris@0:   validates_presence_of :repository_id, :revision, :committed_on, :commit_date
Chris@0:   validates_uniqueness_of :revision, :scope => :repository_id
Chris@0:   validates_uniqueness_of :scmid, :scope => :repository_id, :allow_nil => true
Chris@0:   
Chris@0:   named_scope :visible, lambda {|*args| { :include => {:repository => :project},
Chris@0:                                           :conditions => Project.allowed_to_condition(args.first || User.current, :view_changesets) } }
Chris@0:                                           
Chris@0:   def revision=(r)
Chris@0:     write_attribute :revision, (r.nil? ? nil : r.to_s)
Chris@0:   end
Chris@3: 
Chris@3:   # Returns the identifier of this changeset.
Chris@3:   # e.g. revision number for centralized system; hash id for DVCS
Chris@3:   def identifier
Chris@3:     scmid || revision
Chris@3:   end
Chris@3: 
Chris@3:   # Returns the wiki identifier, "rN" or "commit:ABCDEF"
Chris@3:   def wiki_identifier
Chris@3:     if scmid  # hash-like
Chris@3:       "commit:#{scmid}"
Chris@3:     else  # numeric
Chris@3:       "r#{revision}"
Chris@3:     end
Chris@3:   end
Chris@3:   private :wiki_identifier
Chris@0:   
Chris@0:   def comments=(comment)
Chris@0:     write_attribute(:comments, Changeset.normalize_comments(comment))
Chris@0:   end
Chris@0: 
Chris@0:   def committed_on=(date)
Chris@0:     self.commit_date = date
Chris@0:     super
Chris@0:   end
Chris@0:   
Chris@0:   def committer=(arg)
Chris@0:     write_attribute(:committer, self.class.to_utf8(arg.to_s))
Chris@0:   end
Chris@0: 
Chris@0:   def project
Chris@0:     repository.project
Chris@0:   end
Chris@0:   
Chris@0:   def author
Chris@0:     user || committer.to_s.split('<').first
Chris@0:   end
Chris@0:   
Chris@0:   def before_create
Chris@0:     self.user = repository.find_committer_user(committer)
Chris@0:   end
Chris@0:   
Chris@0:   def after_create
Chris@0:     scan_comment_for_issue_ids
Chris@0:   end
Chris@0:   
Chris@0:   def scan_comment_for_issue_ids
Chris@0:     return if comments.blank?
Chris@0:     # keywords used to reference issues
Chris@0:     ref_keywords = Setting.commit_ref_keywords.downcase.split(",").collect(&:strip)
Chris@0:     # keywords used to fix issues
Chris@0:     fix_keywords = Setting.commit_fix_keywords.downcase.split(",").collect(&:strip)
Chris@0:     
Chris@0:     kw_regexp = (ref_keywords + fix_keywords).collect{|kw| Regexp.escape(kw)}.join("|")
Chris@0:     return if kw_regexp.blank?
Chris@0:     
Chris@0:     referenced_issues = []
Chris@0:     
Chris@0:     if ref_keywords.delete('*')
Chris@0:       # find any issue ID in the comments
Chris@0:       target_issue_ids = []
Chris@0:       comments.scan(%r{([\s\(\[,-]|^)#(\d+)(?=[[:punct:]]|\s|<|$)}).each { |m| target_issue_ids << m[1] }
Chris@0:       referenced_issues += find_referenced_issues_by_id(target_issue_ids)
Chris@0:     end
Chris@0:     
Chris@0:     comments.scan(Regexp.new("(#{kw_regexp})[\s:]+(([\s,;&]*#?\\d+)+)", Regexp::IGNORECASE)).each do |match|
Chris@0:       action = match[0]
Chris@0:       target_issue_ids = match[1].scan(/\d+/)
Chris@0:       target_issues = find_referenced_issues_by_id(target_issue_ids)
Chris@0:       if fix_keywords.include?(action.downcase) && fix_status = IssueStatus.find_by_id(Setting.commit_fix_status_id)
Chris@0:         # update status of issues
Chris@0:         logger.debug "Issues fixed by changeset #{self.revision}: #{issue_ids.join(', ')}." if logger && logger.debug?
Chris@0:         target_issues.each do |issue|
Chris@0:           # the issue may have been updated by the closure of another one (eg. duplicate)
Chris@0:           issue.reload
Chris@0:           # don't change the status is the issue is closed
Chris@0:           next if issue.status.is_closed?
Chris@3:           journal = issue.init_journal(user || User.anonymous, ll(Setting.default_language, :text_status_changed_by_changeset, wiki_identifier))
Chris@0:           issue.status = fix_status
Chris@0:           unless Setting.commit_fix_done_ratio.blank?
Chris@0:             issue.done_ratio = Setting.commit_fix_done_ratio.to_i
Chris@0:           end
Chris@0:           Redmine::Hook.call_hook(:model_changeset_scan_commit_for_issue_ids_pre_issue_update,
Chris@0:                                   { :changeset => self, :issue => issue })
Chris@0:           issue.save
Chris@0:         end
Chris@0:       end
Chris@0:       referenced_issues += target_issues
Chris@0:     end
Chris@0:     
Chris@0:     referenced_issues.uniq!
Chris@0:     self.issues = referenced_issues unless referenced_issues.empty?
Chris@0:   end
Chris@0:   
Chris@0:   def short_comments
Chris@0:     @short_comments || split_comments.first
Chris@0:   end
Chris@0:   
Chris@0:   def long_comments
Chris@0:     @long_comments || split_comments.last
Chris@0:   end
Chris@0:   
Chris@0:   # Returns the previous changeset
Chris@0:   def previous
Chris@0:     @previous ||= Changeset.find(:first, :conditions => ['id < ? AND repository_id = ?', self.id, self.repository_id], :order => 'id DESC')
Chris@0:   end
Chris@0: 
Chris@0:   # Returns the next changeset
Chris@0:   def next
Chris@0:     @next ||= Changeset.find(:first, :conditions => ['id > ? AND repository_id = ?', self.id, self.repository_id], :order => 'id ASC')
Chris@0:   end
Chris@0:   
Chris@0:   # Strips and reencodes a commit log before insertion into the database
Chris@0:   def self.normalize_comments(str)
Chris@0:     to_utf8(str.to_s.strip)
Chris@0:   end
Chris@0: 
Chris@0:   # Creates a new Change from it's common parameters
Chris@0:   def create_change(change)
Chris@0:     Change.create(:changeset => self,
Chris@0:                   :action => change[:action],
Chris@0:                   :path => change[:path],
Chris@0:                   :from_path => change[:from_path],
Chris@0:                   :from_revision => change[:from_revision])
Chris@0:   end
Chris@0:   
Chris@0:   private
Chris@0: 
Chris@0:   # Finds issues that can be referenced by the commit message
Chris@0:   # i.e. issues that belong to the repository project, a subproject or a parent project
Chris@0:   def find_referenced_issues_by_id(ids)
Chris@0:     return [] if ids.compact.empty?
Chris@0:     Issue.find_all_by_id(ids, :include => :project).select {|issue|
Chris@0:       project == issue.project || project.is_ancestor_of?(issue.project) || project.is_descendant_of?(issue.project)
Chris@0:     }
Chris@0:   end
Chris@0:   
Chris@0:   def split_comments
Chris@0:     comments =~ /\A(.+?)\r?\n(.*)$/m
Chris@0:     @short_comments = $1 || comments
Chris@0:     @long_comments = $2.to_s.strip
Chris@0:     return @short_comments, @long_comments
Chris@0:   end
Chris@0: 
Chris@0:   def self.to_utf8(str)
Chris@0:     return str if /\A[\r\n\t\x20-\x7e]*\Z/n.match(str) # for us-ascii
Chris@0:     encoding = Setting.commit_logs_encoding.to_s.strip
Chris@0:     unless encoding.blank? || encoding == 'UTF-8'
Chris@0:       begin
Chris@0:         str = Iconv.conv('UTF-8', encoding, str)
Chris@0:       rescue Iconv::Failure
Chris@0:         # do nothing here
Chris@0:       end
Chris@0:     end
Chris@0:     # removes invalid UTF8 sequences
Chris@0:     begin
Chris@0:       Iconv.conv('UTF-8//IGNORE', 'UTF-8', str + '  ')[0..-3]
Chris@0:     rescue Iconv::InvalidEncoding
Chris@0:       # "UTF-8//IGNORE" is not supported on some OS
Chris@0:       str
Chris@0:     end
Chris@0:   end
Chris@0: end