Chris@1517: # Redmine - project management software
Chris@1517: # Copyright (C) 2006-2014  Jean-Philippe Lang
Chris@1517: #
Chris@1517: # This program is free software; you can redistribute it and/or
Chris@1517: # modify it under the terms of the GNU General Public License
Chris@1517: # as published by the Free Software Foundation; either version 2
Chris@1517: # of the License, or (at your option) any later version.
Chris@1517: #
Chris@1517: # This program is distributed in the hope that it will be useful,
Chris@1517: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1517: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1517: # GNU General Public License for more details.
Chris@1517: #
Chris@1517: # You should have received a copy of the GNU General Public License
Chris@1517: # along with this program; if not, write to the Free Software
Chris@1517: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1517: 
Chris@1517: require 'redmine/scm/adapters/mercurial_adapter'
Chris@1517: 
Chris@1517: class Repository::Mercurial < Repository
Chris@1517:   # sort changesets by revision number
Chris@1517:   has_many :changesets,
Chris@1517:            :order       => "#{Changeset.table_name}.id DESC",
Chris@1517:            :foreign_key => 'repository_id'
Chris@1517: 
Chris@1517:   attr_protected        :root_url
Chris@1517:   validates_presence_of :url
Chris@1517: 
Chris@1517:   # number of changesets to fetch at once
Chris@1517:   FETCH_AT_ONCE = 100
Chris@1517: 
Chris@1517:   def self.human_attribute_name(attribute_key_name, *args)
Chris@1517:     attr_name = attribute_key_name.to_s
Chris@1517:     if attr_name == "url"
Chris@1517:       attr_name = "path_to_repository"
Chris@1517:     end
Chris@1517:     super(attr_name, *args)
Chris@1517:   end
Chris@1517: 
Chris@1517:   def self.scm_adapter_class
Chris@1517:     Redmine::Scm::Adapters::MercurialAdapter
Chris@1517:   end
Chris@1517: 
Chris@1517:   def self.scm_name
Chris@1517:     'Mercurial'
Chris@1517:   end
Chris@1517: 
Chris@1517:   def supports_directory_revisions?
Chris@1517:     true
Chris@1517:   end
Chris@1517: 
Chris@1517:   def supports_revision_graph?
Chris@1517:     true
Chris@1517:   end
Chris@1517: 
Chris@1517:   def repo_log_encoding
Chris@1517:     'UTF-8'
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Returns the readable identifier for the given mercurial changeset
Chris@1517:   def self.format_changeset_identifier(changeset)
Chris@1517:     "#{changeset.revision}:#{changeset.scmid[0, 12]}"
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Returns the identifier for the given Mercurial changeset
Chris@1517:   def self.changeset_identifier(changeset)
Chris@1517:     changeset.scmid
Chris@1517:   end
Chris@1517: 
Chris@1517:   def diff_format_revisions(cs, cs_to, sep=':')
Chris@1517:     super(cs, cs_to, ' ')
Chris@1517:   end
Chris@1517: 
Chris@1517:   def modify_entry_lastrev_identifier(entry)
Chris@1517:     if entry.lastrev && entry.lastrev.identifier
Chris@1517:       entry.lastrev.identifier = scmid_for_inserting_db(entry.lastrev.identifier)
Chris@1517:     end
Chris@1517:   end
Chris@1517:   private :modify_entry_lastrev_identifier
Chris@1517: 
Chris@1517:   def entry(path=nil, identifier=nil)
Chris@1517:     entry = scm.entry(path, identifier)
Chris@1517:     return nil if entry.nil?
Chris@1517:     modify_entry_lastrev_identifier(entry)
Chris@1517:     entry
Chris@1517:   end
Chris@1517: 
Chris@1517:   def scm_entries(path=nil, identifier=nil)
Chris@1517:     entries = scm.entries(path, identifier)
Chris@1517:     return nil if entries.nil?
Chris@1517:     entries.each {|entry| modify_entry_lastrev_identifier(entry)}
Chris@1517:     entries
Chris@1517:   end
Chris@1517:   protected :scm_entries
Chris@1517: 
Chris@1517:   # Finds and returns a revision with a number or the beginning of a hash
Chris@1517:   def find_changeset_by_name(name)
Chris@1517:     return nil if name.blank?
Chris@1517:     s = name.to_s
Chris@1517:     if /[^\d]/ =~ s or s.size > 8
Chris@1517:       cs = changesets.where(:scmid => s).first
Chris@1517:     else
Chris@1517:       cs = changesets.where(:revision => s).first
Chris@1517:     end
Chris@1517:     return cs if cs
Chris@1517:     changesets.where('scmid LIKE ?', "#{s}%").first
Chris@1517:   end
Chris@1517: 
Chris@1517:   # Returns the latest changesets for +path+; sorted by revision number
Chris@1517:   #
Chris@1517:   # Because :order => 'id DESC' is defined at 'has_many',
Chris@1517:   # there is no need to set 'order'.
Chris@1517:   # But, MySQL test fails.
Chris@1517:   # Sqlite3 and PostgreSQL pass.
Chris@1517:   # Is this MySQL bug?
Chris@1517:   def latest_changesets(path, rev, limit=10)
Chris@1517:     changesets.
Chris@1517:       includes(:user).
Chris@1517:       where(latest_changesets_cond(path, rev, limit)).
Chris@1517:       limit(limit).
Chris@1517:       order("#{Changeset.table_name}.id DESC").
Chris@1517:       all
Chris@1517:   end
Chris@1517: 
Chris@1517:   def is_short_id_in_db?
Chris@1517:     return @is_short_id_in_db unless @is_short_id_in_db.nil?
Chris@1517:     cs = changesets.first
Chris@1517:     @is_short_id_in_db = (!cs.nil? && cs.scmid.length != 40)
Chris@1517:   end
Chris@1517:   private :is_short_id_in_db?
Chris@1517: 
Chris@1517:   def scmid_for_inserting_db(scmid)
Chris@1517:     is_short_id_in_db? ? scmid[0, 12] : scmid
Chris@1517:   end
Chris@1517: 
Chris@1517:   def nodes_in_branch(rev, branch_limit)
Chris@1517:     scm.nodes_in_branch(rev, :limit => branch_limit).collect do |b|
Chris@1517:       scmid_for_inserting_db(b)
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def tag_scmid(rev)
Chris@1517:     scmid = scm.tagmap[rev]
Chris@1517:     scmid.nil? ? nil : scmid_for_inserting_db(scmid)
Chris@1517:   end
Chris@1517: 
Chris@1517:   def latest_changesets_cond(path, rev, limit)
Chris@1517:     cond, args = [], []
Chris@1517:     if scm.branchmap.member? rev
Chris@1517:       # Mercurial named branch is *stable* in each revision.
Chris@1517:       # So, named branch can be stored in database.
Chris@1517:       # Mercurial provides *bookmark* which is equivalent with git branch.
Chris@1517:       # But, bookmark is not implemented.
Chris@1517:       cond << "#{Changeset.table_name}.scmid IN (?)"
Chris@1517:       # Revisions in root directory and sub directory are not equal.
Chris@1517:       # So, in order to get correct limit, we need to get all revisions.
Chris@1517:       # But, it is very heavy.
Chris@1517:       # Mercurial does not treat direcotry.
Chris@1517:       # So, "hg log DIR" is very heavy.
Chris@1517:       branch_limit = path.blank? ? limit : ( limit * 5 )
Chris@1517:       args << nodes_in_branch(rev, branch_limit)
Chris@1517:     elsif last = rev ? find_changeset_by_name(tag_scmid(rev) || rev) : nil
Chris@1517:       cond << "#{Changeset.table_name}.id <= ?"
Chris@1517:       args << last.id
Chris@1517:     end
Chris@1517:     unless path.blank?
Chris@1517:       cond << "EXISTS (SELECT * FROM #{Change.table_name}
Chris@1517:                  WHERE #{Change.table_name}.changeset_id = #{Changeset.table_name}.id
Chris@1517:                  AND (#{Change.table_name}.path = ?
Chris@1517:                        OR #{Change.table_name}.path LIKE ? ESCAPE ?))"
Chris@1517:       args << path.with_leading_slash
Chris@1517:       args << "#{path.with_leading_slash.gsub(%r{[%_\\]}) { |s| "\\#{s}" }}/%" << '\\'
Chris@1517:     end
Chris@1517:     [cond.join(' AND '), *args] unless cond.empty?
Chris@1517:   end
Chris@1517:   private :latest_changesets_cond
Chris@1517: 
Chris@1517:   def fetch_changesets
Chris@1517:     return if scm.info.nil?
Chris@1517:     scm_rev = scm.info.lastrev.revision.to_i
Chris@1517:     db_rev  = latest_changeset ? latest_changeset.revision.to_i : -1
Chris@1517:     return unless db_rev < scm_rev  # already up-to-date
Chris@1517: 
Chris@1517:     logger.debug "Fetching changesets for repository #{url}" if logger
Chris@1517:     (db_rev + 1).step(scm_rev, FETCH_AT_ONCE) do |i|
Chris@1517:       scm.each_revision('', i, [i + FETCH_AT_ONCE - 1, scm_rev].min) do |re|
Chris@1517:         transaction do
Chris@1517:           parents = (re.parents || []).collect do |rp|
Chris@1517:             find_changeset_by_name(scmid_for_inserting_db(rp))
Chris@1517:           end.compact
Chris@1517:           cs = Changeset.create(:repository   => self,
Chris@1517:                                 :revision     => re.revision,
Chris@1517:                                 :scmid        => scmid_for_inserting_db(re.scmid),
Chris@1517:                                 :committer    => re.author,
Chris@1517:                                 :committed_on => re.time,
Chris@1517:                                 :comments     => re.message,
Chris@1517:                                 :parents      => parents)
Chris@1517:           unless cs.new_record?
Chris@1517:             re.paths.each do |e|
Chris@1517:               if from_revision = e[:from_revision]
Chris@1517:                 e[:from_revision] = scmid_for_inserting_db(from_revision)
Chris@1517:               end
Chris@1517:               cs.create_change(e)
Chris@1517:             end
Chris@1517:           end
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: end