Chris@1295: # Redmine - project management software
Chris@1295: # Copyright (C) 2006-2012  Jean-Philippe Lang
Chris@1295: #
Chris@1295: # This program is free software; you can redistribute it and/or
Chris@1295: # modify it under the terms of the GNU General Public License
Chris@1295: # as published by the Free Software Foundation; either version 2
Chris@1295: # of the License, or (at your option) any later version.
Chris@1295: #
Chris@1295: # This program is distributed in the hope that it will be useful,
Chris@1295: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1295: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1295: # GNU General Public License for more details.
Chris@1295: #
Chris@1295: # You should have received a copy of the GNU General Public License
Chris@1295: # along with this program; if not, write to the Free Software
Chris@1295: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1295: 
Chris@1295: require 'iconv'
Chris@1295: 
Chris@1295: class Changeset < ActiveRecord::Base
Chris@1295:   belongs_to :repository
Chris@1295:   belongs_to :user
Chris@1295:   has_many :filechanges, :class_name => 'Change', :dependent => :delete_all
Chris@1295:   has_and_belongs_to_many :issues
Chris@1295:   has_and_belongs_to_many :parents,
Chris@1295:                           :class_name => "Changeset",
Chris@1295:                           :join_table => "#{table_name_prefix}changeset_parents#{table_name_suffix}",
Chris@1295:                           :association_foreign_key => 'parent_id', :foreign_key => 'changeset_id'
Chris@1295:   has_and_belongs_to_many :children,
Chris@1295:                           :class_name => "Changeset",
Chris@1295:                           :join_table => "#{table_name_prefix}changeset_parents#{table_name_suffix}",
Chris@1295:                           :association_foreign_key => 'changeset_id', :foreign_key => 'parent_id'
Chris@1295: 
Chris@1295:   acts_as_event :title => Proc.new {|o| o.title},
Chris@1295:                 :description => :long_comments,
Chris@1295:                 :datetime => :committed_on,
Chris@1295:                 :url => Proc.new {|o| {:controller => 'repositories', :action => 'revision', :id => o.repository.project, :repository_id => o.repository.identifier_param, :rev => o.identifier}}
Chris@1295: 
Chris@1295:   acts_as_searchable :columns => 'comments',
Chris@1295:                      :include => {:repository => :project},
Chris@1295:                      :project_key => "#{Repository.table_name}.project_id",
Chris@1295:                      :date_column => 'committed_on'
Chris@1295: 
Chris@1295:   acts_as_activity_provider :timestamp => "#{table_name}.committed_on",
Chris@1295:                             :author_key => :user_id,
Chris@1295:                             :find_options => {:include => [:user, {:repository => :project}]}
Chris@1295: 
Chris@1295:   validates_presence_of :repository_id, :revision, :committed_on, :commit_date
Chris@1295:   validates_uniqueness_of :revision, :scope => :repository_id
Chris@1295:   validates_uniqueness_of :scmid, :scope => :repository_id, :allow_nil => true
Chris@1295: 
Chris@1295:   scope :visible,
Chris@1295:      lambda {|*args| { :include => {:repository => :project},
Chris@1295:                                           :conditions => Project.allowed_to_condition(args.shift || User.current, :view_changesets, *args) } }
Chris@1295: 
Chris@1295:   after_create :scan_for_issues
Chris@1295:   before_create :before_create_cs
Chris@1295: 
Chris@1295:   def revision=(r)
Chris@1295:     write_attribute :revision, (r.nil? ? nil : r.to_s)
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the identifier of this changeset; depending on repository backends
Chris@1295:   def identifier
Chris@1295:     if repository.class.respond_to? :changeset_identifier
Chris@1295:       repository.class.changeset_identifier self
Chris@1295:     else
Chris@1295:       revision.to_s
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def committed_on=(date)
Chris@1295:     self.commit_date = date
Chris@1295:     super
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the readable identifier
Chris@1295:   def format_identifier
Chris@1295:     if repository.class.respond_to? :format_changeset_identifier
Chris@1295:       repository.class.format_changeset_identifier self
Chris@1295:     else
Chris@1295:       identifier
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def project
Chris@1295:     repository.project
Chris@1295:   end
Chris@1295: 
Chris@1295:   def author
Chris@1295:     user || committer.to_s.split('<').first
Chris@1295:   end
Chris@1295: 
Chris@1295:   def before_create_cs
Chris@1295:     self.committer = self.class.to_utf8(self.committer, repository.repo_log_encoding)
Chris@1295:     self.comments  = self.class.normalize_comments(
Chris@1295:                        self.comments, repository.repo_log_encoding)
Chris@1295:     self.user = repository.find_committer_user(self.committer)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def scan_for_issues
Chris@1295:     scan_comment_for_issue_ids
Chris@1295:   end
Chris@1295: 
Chris@1295:   TIMELOG_RE = /
Chris@1295:     (
Chris@1295:     ((\d+)(h|hours?))((\d+)(m|min)?)?
Chris@1295:     |
Chris@1295:     ((\d+)(h|hours?|m|min))
Chris@1295:     |
Chris@1295:     (\d+):(\d+)
Chris@1295:     |
Chris@1295:     (\d+([\.,]\d+)?)h?
Chris@1295:     )
Chris@1295:     /x
Chris@1295: 
Chris@1295:   def scan_comment_for_issue_ids
Chris@1295:     return if comments.blank?
Chris@1295:     # keywords used to reference issues
Chris@1295:     ref_keywords = Setting.commit_ref_keywords.downcase.split(",").collect(&:strip)
Chris@1295:     ref_keywords_any = ref_keywords.delete('*')
Chris@1295:     # keywords used to fix issues
Chris@1295:     fix_keywords = Setting.commit_fix_keywords.downcase.split(",").collect(&:strip)
Chris@1295: 
Chris@1295:     kw_regexp = (ref_keywords + fix_keywords).collect{|kw| Regexp.escape(kw)}.join("|")
Chris@1295: 
Chris@1295:     referenced_issues = []
Chris@1295: 
Chris@1295:     comments.scan(/([\s\(\[,-]|^)((#{kw_regexp})[\s:]+)?(#\d+(\s+@#{TIMELOG_RE})?([\s,;&]+#\d+(\s+@#{TIMELOG_RE})?)*)(?=[[:punct:]]|\s|<|$)/i) do |match|
Chris@1295:       action, refs = match[2], match[3]
Chris@1295:       next unless action.present? || ref_keywords_any
Chris@1295: 
Chris@1295:       refs.scan(/#(\d+)(\s+@#{TIMELOG_RE})?/).each do |m|
Chris@1295:         issue, hours = find_referenced_issue_by_id(m[0].to_i), m[2]
Chris@1295:         if issue
Chris@1295:           referenced_issues << issue
Chris@1295:           fix_issue(issue) if fix_keywords.include?(action.to_s.downcase)
Chris@1295:           log_time(issue, hours) if hours && Setting.commit_logtime_enabled?
Chris@1295:         end
Chris@1295:       end
Chris@1295:     end
Chris@1295: 
Chris@1295:     referenced_issues.uniq!
Chris@1295:     self.issues = referenced_issues unless referenced_issues.empty?
Chris@1295:   end
Chris@1295: 
Chris@1295:   def short_comments
Chris@1295:     @short_comments || split_comments.first
Chris@1295:   end
Chris@1295: 
Chris@1295:   def long_comments
Chris@1295:     @long_comments || split_comments.last
Chris@1295:   end
Chris@1295: 
Chris@1295:   def text_tag(ref_project=nil)
Chris@1295:     tag = if scmid?
Chris@1295:       "commit:#{scmid}"
Chris@1295:     else
Chris@1295:       "r#{revision}"
Chris@1295:     end
Chris@1295:     if repository && repository.identifier.present?
Chris@1295:       tag = "#{repository.identifier}|#{tag}"
Chris@1295:     end
Chris@1295:     if ref_project && project && ref_project != project
Chris@1295:       tag = "#{project.identifier}:#{tag}"
Chris@1295:     end
Chris@1295:     tag
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the title used for the changeset in the activity/search results
Chris@1295:   def title
Chris@1295:     repo = (repository && repository.identifier.present?) ? " (#{repository.identifier})" : ''
Chris@1295:     comm = short_comments.blank? ? '' : (': ' + short_comments)
Chris@1295:     "#{l(:label_revision)} #{format_identifier}#{repo}#{comm}"
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the previous changeset
Chris@1295:   def previous
Chris@1295:     @previous ||= Changeset.where(["id < ? AND repository_id = ?", id, repository_id]).order('id DESC').first
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the next changeset
Chris@1295:   def next
Chris@1295:     @next ||= Changeset.where(["id > ? AND repository_id = ?", id, repository_id]).order('id ASC').first
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Creates a new Change from it's common parameters
Chris@1295:   def create_change(change)
Chris@1295:     Change.create(:changeset     => self,
Chris@1295:                   :action        => change[:action],
Chris@1295:                   :path          => change[:path],
Chris@1295:                   :from_path     => change[:from_path],
Chris@1295:                   :from_revision => change[:from_revision])
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Finds an issue that can be referenced by the commit message
Chris@1295:   def find_referenced_issue_by_id(id)
Chris@1295:     return nil if id.blank?
Chris@1295:     issue = Issue.find_by_id(id.to_i, :include => :project)
Chris@1295:     if Setting.commit_cross_project_ref?
Chris@1295:       # all issues can be referenced/fixed
Chris@1295:     elsif issue
Chris@1295:       # issue that belong to the repository project, a subproject or a parent project only
Chris@1295:       unless issue.project &&
Chris@1295:                 (project == issue.project || project.is_ancestor_of?(issue.project) ||
Chris@1295:                  project.is_descendant_of?(issue.project))
Chris@1295:         issue = nil
Chris@1295:       end
Chris@1295:     end
Chris@1295:     issue
Chris@1295:   end
Chris@1295: 
Chris@1295:   private
Chris@1295: 
Chris@1295:   def fix_issue(issue)
Chris@1295:     status = IssueStatus.find_by_id(Setting.commit_fix_status_id.to_i)
Chris@1295:     if status.nil?
Chris@1295:       logger.warn("No status matches commit_fix_status_id setting (#{Setting.commit_fix_status_id})") if logger
Chris@1295:       return issue
Chris@1295:     end
Chris@1295: 
Chris@1295:     # the issue may have been updated by the closure of another one (eg. duplicate)
Chris@1295:     issue.reload
Chris@1295:     # don't change the status is the issue is closed
Chris@1295:     return if issue.status && issue.status.is_closed?
Chris@1295: 
Chris@1295:     journal = issue.init_journal(user || User.anonymous, ll(Setting.default_language, :text_status_changed_by_changeset, text_tag(issue.project)))
Chris@1295:     issue.status = status
Chris@1295:     unless Setting.commit_fix_done_ratio.blank?
Chris@1295:       issue.done_ratio = Setting.commit_fix_done_ratio.to_i
Chris@1295:     end
Chris@1295:     Redmine::Hook.call_hook(:model_changeset_scan_commit_for_issue_ids_pre_issue_update,
Chris@1295:                             { :changeset => self, :issue => issue })
Chris@1295:     unless issue.save
Chris@1295:       logger.warn("Issue ##{issue.id} could not be saved by changeset #{id}: #{issue.errors.full_messages}") if logger
Chris@1295:     end
Chris@1295:     issue
Chris@1295:   end
Chris@1295: 
Chris@1295:   def log_time(issue, hours)
Chris@1295:     time_entry = TimeEntry.new(
Chris@1295:       :user => user,
Chris@1295:       :hours => hours,
Chris@1295:       :issue => issue,
Chris@1295:       :spent_on => commit_date,
Chris@1295:       :comments => l(:text_time_logged_by_changeset, :value => text_tag(issue.project),
Chris@1295:                      :locale => Setting.default_language)
Chris@1295:       )
Chris@1295:     time_entry.activity = log_time_activity unless log_time_activity.nil?
Chris@1295: 
Chris@1295:     unless time_entry.save
Chris@1295:       logger.warn("TimeEntry could not be created by changeset #{id}: #{time_entry.errors.full_messages}") if logger
Chris@1295:     end
Chris@1295:     time_entry
Chris@1295:   end
Chris@1295: 
Chris@1295:   def log_time_activity
Chris@1295:     if Setting.commit_logtime_activity_id.to_i > 0
Chris@1295:       TimeEntryActivity.find_by_id(Setting.commit_logtime_activity_id.to_i)
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def split_comments
Chris@1295:     comments =~ /\A(.+?)\r?\n(.*)$/m
Chris@1295:     @short_comments = $1 || comments
Chris@1295:     @long_comments = $2.to_s.strip
Chris@1295:     return @short_comments, @long_comments
Chris@1295:   end
Chris@1295: 
Chris@1295:   public
Chris@1295: 
Chris@1295:   # Strips and reencodes a commit log before insertion into the database
Chris@1295:   def self.normalize_comments(str, encoding)
Chris@1295:     Changeset.to_utf8(str.to_s.strip, encoding)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def self.to_utf8(str, encoding)
Chris@1295:     Redmine::CodesetUtil.to_utf8(str, encoding)
Chris@1295:   end
Chris@1295: end