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: class ScmFetchError < Exception; end
Chris@909: 
Chris@909: class Repository < ActiveRecord::Base
Chris@909:   include Redmine::Ciphering
Chris@909: 
Chris@909:   belongs_to :project
Chris@909:   has_many :changesets, :order => "#{Changeset.table_name}.committed_on DESC, #{Changeset.table_name}.id DESC"
Chris@909:   has_many :changes, :through => :changesets
Chris@909: 
Chris@909:   serialize :extra_info
Chris@909: 
Chris@909:   # Raw SQL to delete changesets and changes in the database
Chris@909:   # has_many :changesets, :dependent => :destroy is too slow for big repositories
Chris@909:   before_destroy :clear_changesets
Chris@909: 
Chris@909:   validates_length_of :password, :maximum => 255, :allow_nil => true
Chris@909:   # Checks if the SCM is enabled when creating a repository
Chris@909:   validate :repo_create_validation, :on => :create
Chris@909: 
Chris@909:   def repo_create_validation
Chris@909:     unless Setting.enabled_scm.include?(self.class.name.demodulize)
Chris@909:       errors.add(:type, :invalid)
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def self.human_attribute_name(attribute_key_name)
Chris@909:     attr_name = attribute_key_name
Chris@909:     if attr_name == "log_encoding"
Chris@909:       attr_name = "commit_logs_encoding"
Chris@909:     end
Chris@909:     super(attr_name)
Chris@909:   end
Chris@909: 
Chris@909:   # Removes leading and trailing whitespace
Chris@909:   def url=(arg)
Chris@909:     write_attribute(:url, arg ? arg.to_s.strip : nil)
Chris@909:   end
Chris@909: 
Chris@909:   # Removes leading and trailing whitespace
Chris@909:   def root_url=(arg)
Chris@909:     write_attribute(:root_url, arg ? arg.to_s.strip : nil)
Chris@909:   end
Chris@909: 
Chris@909:   def password
Chris@909:     read_ciphered_attribute(:password)
Chris@909:   end
Chris@909: 
Chris@909:   def password=(arg)
Chris@909:     write_ciphered_attribute(:password, arg)
Chris@909:   end
Chris@909: 
Chris@909:   def scm_adapter
Chris@909:     self.class.scm_adapter_class
Chris@909:   end
Chris@909: 
Chris@909:   def scm
Chris@909:     @scm ||= self.scm_adapter.new(url, root_url,
Chris@909:                                   login, password, path_encoding)
Chris@909:     update_attribute(:root_url, @scm.root_url) if root_url.blank?
Chris@909:     @scm
Chris@909:   end
Chris@909: 
Chris@909:   def scm_name
Chris@909:     self.class.scm_name
Chris@909:   end
Chris@909: 
Chris@909:   def merge_extra_info(arg)
Chris@909:     h = extra_info || {}
Chris@909:     return h if arg.nil?
Chris@909:     h.merge!(arg)
Chris@909:     write_attribute(:extra_info, h)
Chris@909:   end
Chris@909: 
Chris@909:   def report_last_commit
Chris@909:     true
Chris@909:   end
Chris@909: 
Chris@909:   def supports_cat?
Chris@909:     scm.supports_cat?
Chris@909:   end
Chris@909: 
Chris@909:   def supports_annotate?
Chris@909:     scm.supports_annotate?
Chris@909:   end
Chris@909: 
Chris@909:   def supports_all_revisions?
Chris@909:     true
Chris@909:   end
Chris@909: 
Chris@909:   def supports_directory_revisions?
Chris@909:     false
Chris@909:   end
Chris@909: 
Chris@909:   def supports_revision_graph?
Chris@909:     false
Chris@909:   end
Chris@909: 
Chris@909:   def entry(path=nil, identifier=nil)
Chris@909:     scm.entry(path, identifier)
Chris@909:   end
Chris@909: 
Chris@909:   def entries(path=nil, identifier=nil)
Chris@909:     scm.entries(path, identifier)
Chris@909:   end
Chris@909: 
Chris@909:   def branches
Chris@909:     scm.branches
Chris@909:   end
Chris@909: 
Chris@909:   def tags
Chris@909:     scm.tags
Chris@909:   end
Chris@909: 
Chris@909:   def default_branch
Chris@909:     nil
Chris@909:   end
Chris@909: 
Chris@909:   def properties(path, identifier=nil)
Chris@909:     scm.properties(path, identifier)
Chris@909:   end
Chris@909: 
Chris@909:   def cat(path, identifier=nil)
Chris@909:     scm.cat(path, identifier)
Chris@909:   end
Chris@909: 
Chris@909:   def diff(path, rev, rev_to)
Chris@909:     scm.diff(path, rev, rev_to)
Chris@909:   end
Chris@909: 
Chris@909:   def diff_format_revisions(cs, cs_to, sep=':')
Chris@909:     text = ""
Chris@909:     text << cs_to.format_identifier + sep if cs_to
Chris@909:     text << cs.format_identifier if cs
Chris@909:     text
Chris@909:   end
Chris@909: 
Chris@909:   # Returns a path relative to the url of the repository
Chris@909:   def relative_path(path)
Chris@909:     path
Chris@909:   end
Chris@909: 
Chris@909:   # Finds and returns a revision with a number or the beginning of a hash
Chris@909:   def find_changeset_by_name(name)
Chris@909:     return nil if name.blank?
Chris@909:     changesets.find(:first, :conditions => (name.match(/^\d*$/) ?
Chris@909:           ["revision = ?", name.to_s] : ["revision LIKE ?", name + '%']))
Chris@909:   end
Chris@909: 
Chris@909:   def latest_changeset
Chris@909:     @latest_changeset ||= changesets.find(:first)
Chris@909:   end
Chris@909: 
Chris@909:   # Returns the latest changesets for +path+
Chris@909:   # Default behaviour is to search in cached changesets
Chris@909:   def latest_changesets(path, rev, limit=10)
Chris@909:     if path.blank?
Chris@909:       changesets.find(
Chris@909:          :all,
Chris@909:          :include => :user,
Chris@909:          :order => "#{Changeset.table_name}.committed_on DESC, #{Changeset.table_name}.id DESC",
Chris@909:          :limit => limit)
Chris@909:     else
Chris@909:       changes.find(
Chris@909:          :all,
Chris@909:          :include => {:changeset => :user},
Chris@909:          :conditions => ["path = ?", path.with_leading_slash],
Chris@909:          :order => "#{Changeset.table_name}.committed_on DESC, #{Changeset.table_name}.id DESC",
Chris@909:          :limit => limit
Chris@909:        ).collect(&:changeset)
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def scan_changesets_for_issue_ids
Chris@909:     self.changesets.each(&:scan_comment_for_issue_ids)
Chris@909:   end
Chris@909: 
Chris@909:   # Returns an array of committers usernames and associated user_id
Chris@909:   def committers
Chris@909:     @committers ||= Changeset.connection.select_rows(
Chris@909:          "SELECT DISTINCT committer, user_id FROM #{Changeset.table_name} WHERE repository_id = #{id}")
Chris@909:   end
Chris@909: 
Chris@909:   # Maps committers username to a user ids
Chris@909:   def committer_ids=(h)
Chris@909:     if h.is_a?(Hash)
Chris@909:       committers.each do |committer, user_id|
Chris@909:         new_user_id = h[committer]
Chris@909:         if new_user_id && (new_user_id.to_i != user_id.to_i)
Chris@909:           new_user_id = (new_user_id.to_i > 0 ? new_user_id.to_i : nil)
Chris@909:           Changeset.update_all(
Chris@909:                "user_id = #{ new_user_id.nil? ? 'NULL' : new_user_id }",
Chris@909:                ["repository_id = ? AND committer = ?", id, committer])
Chris@909:         end
Chris@909:       end
Chris@909:       @committers            = nil
Chris@909:       @found_committer_users = nil
Chris@909:       true
Chris@909:     else
Chris@909:       false
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   # Returns the Redmine User corresponding to the given +committer+
Chris@909:   # It will return nil if the committer is not yet mapped and if no User
Chris@909:   # with the same username or email was found
Chris@909:   def find_committer_user(committer)
Chris@909:     unless committer.blank?
Chris@909:       @found_committer_users ||= {}
Chris@909:       return @found_committer_users[committer] if @found_committer_users.has_key?(committer)
Chris@909: 
Chris@909:       user = nil
Chris@909:       c = changesets.find(:first, :conditions => {:committer => committer}, :include => :user)
Chris@909:       if c && c.user
Chris@909:         user = c.user
Chris@909:       elsif committer.strip =~ /^([^<]+)(<(.*)>)?$/
Chris@909:         username, email = $1.strip, $3
Chris@909:         u = User.find_by_login(username)
Chris@909:         u ||= User.find_by_mail(email) unless email.blank?
Chris@909:         user = u
Chris@909:       end
Chris@909:       @found_committer_users[committer] = user
Chris@909:       user
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def repo_log_encoding
Chris@909:     encoding = log_encoding.to_s.strip
Chris@909:     encoding.blank? ? 'UTF-8' : encoding
Chris@909:   end
Chris@909: 
Chris@909:   # Fetches new changesets for all repositories of active projects
Chris@909:   # Can be called periodically by an external script
Chris@909:   # eg. ruby script/runner "Repository.fetch_changesets"
Chris@909:   def self.fetch_changesets
Chris@909:     Project.active.has_module(:repository).find(:all, :include => :repository).each do |project|
Chris@909:       if project.repository
Chris@909:         begin
Chris@909:           project.repository.fetch_changesets
Chris@909:         rescue Redmine::Scm::Adapters::CommandFailed => e
Chris@909:           logger.error "scm: error during fetching changesets: #{e.message}"
Chris@909:         end
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   # scan changeset comments to find related and fixed issues for all repositories
Chris@909:   def self.scan_changesets_for_issue_ids
Chris@909:     find(:all).each(&:scan_changesets_for_issue_ids)
Chris@909:   end
Chris@909: 
Chris@909:   def self.scm_name
Chris@909:     'Abstract'
Chris@909:   end
Chris@909: 
Chris@909:   def self.available_scm
Chris@909:     subclasses.collect {|klass| [klass.scm_name, klass.name]}
Chris@909:   end
Chris@909: 
Chris@909:   def self.factory(klass_name, *args)
Chris@909:     klass = "Repository::#{klass_name}".constantize
Chris@909:     klass.new(*args)
Chris@909:   rescue
Chris@909:     nil
Chris@909:   end
Chris@909: 
Chris@909:   def self.scm_adapter_class
Chris@909:     nil
Chris@909:   end
Chris@909: 
Chris@909:   def self.scm_command
Chris@909:     ret = ""
Chris@909:     begin
Chris@909:       ret = self.scm_adapter_class.client_command if self.scm_adapter_class
Chris@909:     rescue Exception => e
Chris@909:       logger.error "scm: error during get command: #{e.message}"
Chris@909:     end
Chris@909:     ret
Chris@909:   end
Chris@909: 
Chris@909:   def self.scm_version_string
Chris@909:     ret = ""
Chris@909:     begin
Chris@909:       ret = self.scm_adapter_class.client_version_string if self.scm_adapter_class
Chris@909:     rescue Exception => e
Chris@909:       logger.error "scm: error during get version string: #{e.message}"
Chris@909:     end
Chris@909:     ret
Chris@909:   end
Chris@909: 
Chris@909:   def self.scm_available
Chris@909:     ret = false
Chris@909:     begin
Chris@909:       ret = self.scm_adapter_class.client_available if self.scm_adapter_class
Chris@909:     rescue Exception => e
Chris@909:       logger.error "scm: error during get scm available: #{e.message}"
Chris@909:     end
Chris@909:     ret
Chris@909:   end
Chris@909: 
Chris@909:   private
Chris@909: 
Chris@909:   def clear_changesets
Chris@909:     cs, ch, ci = Changeset.table_name, Change.table_name, "#{table_name_prefix}changesets_issues#{table_name_suffix}"
Chris@909:     connection.delete("DELETE FROM #{ch} WHERE #{ch}.changeset_id IN (SELECT #{cs}.id FROM #{cs} WHERE #{cs}.repository_id = #{id})")
Chris@909:     connection.delete("DELETE FROM #{ci} WHERE #{ci}.changeset_id IN (SELECT #{cs}.id FROM #{cs} WHERE #{cs}.repository_id = #{id})")
Chris@909:     connection.delete("DELETE FROM #{cs} WHERE #{cs}.repository_id = #{id}")
Chris@909:   end
Chris@909: end