jro_apps/redmine Commit - r13673:07795cfed510

Code cleanup....

Jean-Philippe Lang -

r13673:07795cfed510

parent child

Context file:

r13673:07795cfed510

Collapse all files

app/models/repository.rb 0 -4

             # Redmine - project management software
             # Copyright (C) 2006-2015  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.
             class ScmFetchError < Exception; end
             class Repository < ActiveRecord::Base
               include Redmine::Ciphering
               include Redmine::SafeAttributes
               # Maximum length for repository identifiers
               IDENTIFIER_MAX_LENGTH = 255
               belongs_to :project
               has_many :changesets, lambda{order("#{Changeset.table_name}.committed_on DESC, #{Changeset.table_name}.id DESC")}
               has_many :filechanges, :class_name => 'Change', :through => :changesets
               serialize :extra_info
               before_save :check_default
               # Raw SQL to delete changesets and changes in the database
               # has_many :changesets, :dependent => :destroy is too slow for big repositories
               before_destroy :clear_changesets
               validates_length_of :password, :maximum => 255, :allow_nil => true
               validates_length_of :identifier, :maximum => IDENTIFIER_MAX_LENGTH, :allow_blank => true
               validates_uniqueness_of :identifier, :scope => :project_id, :allow_blank => true
               validates_exclusion_of :identifier, :in => %w(browse show entry raw changes annotate diff statistics graph revisions revision)
               # donwcase letters, digits, dashes, underscores but not digits only
               validates_format_of :identifier, :with => /\A(?!\d+$)[a-z0-9\-_]*\z/, :allow_blank => true
               # Checks if the SCM is enabled when creating a repository
               validate :repo_create_validation, :on => :create
               validate :validate_repository_path
               attr_protected :id
               safe_attributes 'identifier',
                 'login',
                 'password',
                 'path_encoding',
                 'log_encoding',
                 'is_default'
               safe_attributes 'url',
                 :if => lambda {|repository, user| repository.new_record?}
               def repo_create_validation
                 unless Setting.enabled_scm.include?(self.class.name.demodulize)
                   errors.add(:type, :invalid)
                 end
               end
               def self.human_attribute_name(attribute_key_name, *args)
                 attr_name = attribute_key_name.to_s
                 if attr_name == "log_encoding"
                   attr_name = "commit_logs_encoding"
                 end
                 super(attr_name, *args)
               end
               # Removes leading and trailing whitespace
               def url=(arg)
                 write_attribute(:url, arg ? arg.to_s.strip : nil)
               end
               # Removes leading and trailing whitespace
               def root_url=(arg)
                 write_attribute(:root_url, arg ? arg.to_s.strip : nil)
               end
               def password
                 read_ciphered_attribute(:password)
               end
               def password=(arg)
                 write_ciphered_attribute(:password, arg)
               end
               def scm_adapter
                 self.class.scm_adapter_class
               end
               def scm
                 unless @scm
                   @scm = self.scm_adapter.new(url, root_url,
                                               login, password, path_encoding)
                   if root_url.blank? && @scm.root_url.present?
                     update_attribute(:root_url, @scm.root_url)
                   end
                 end
                 @scm
               end
               def scm_name
                 self.class.scm_name
               end
               def name
                 if identifier.present?
                   identifier
                 elsif is_default?
                   l(:field_repository_is_default)
                 else
                   scm_name
                 end
               end
               def identifier=(identifier)
                 super unless identifier_frozen?
               end
               def identifier_frozen?
                 errors[:identifier].blank? && !(new_record? || identifier.blank?)
               end
               def identifier_param
                 if is_default?
                   nil
                 elsif identifier.present?
                   identifier
                 else
                   id.to_s
                 end
               end
               def <=>(repository)
                 if is_default?
                   -1
                 elsif repository.is_default?
                 else
                   identifier.to_s <=> repository.identifier.to_s
                 end
               end
               def self.find_by_identifier_param(param)
                 if param.to_s =~ /^\d+$/
                   find_by_id(param)
                 else
                   find_by_identifier(param)
                 end
               end
               # TODO: should return an empty hash instead of nil to avoid many ||{}
               def extra_info
                 h = read_attribute(:extra_info)
                 h.is_a?(Hash) ? h : nil
               end
               def merge_extra_info(arg)
                 h = extra_info || {}
                 return h if arg.nil?
                 h.merge!(arg)
                 write_attribute(:extra_info, h)
               end
               def report_last_commit
                 true
               end
               def supports_cat?
                 scm.supports_cat?
               end
               def supports_annotate?
                 scm.supports_annotate?
               end
               def supports_all_revisions?
                 true
               end
               def supports_directory_revisions?
                 false
               end
               def supports_revision_graph?
                 false
               end
               def entry(path=nil, identifier=nil)
                 scm.entry(path, identifier)
               end
               def scm_entries(path=nil, identifier=nil)
                 scm.entries(path, identifier)
               end
               protected :scm_entries
               def entries(path=nil, identifier=nil)
                 entries = scm_entries(path, identifier)
                 load_entries_changesets(entries)
                 entries
               end
               def branches
                 scm.branches
               end
               def tags
                 scm.tags
               end
               def default_branch
                 nil
               end
               def properties(path, identifier=nil)
                 scm.properties(path, identifier)
               end
               def cat(path, identifier=nil)
                 scm.cat(path, identifier)
               end
               def diff(path, rev, rev_to)
                 scm.diff(path, rev, rev_to)
               end
               def diff_format_revisions(cs, cs_to, sep=':')
                 text = ""
                 text << cs_to.format_identifier + sep if cs_to
                 text << cs.format_identifier if cs
                 text
               end
               # Returns a path relative to the url of the repository
               def relative_path(path)
                 path
               end
               # Finds and returns a revision with a number or the beginning of a hash
               def find_changeset_by_name(name)
                 return nil if name.blank?
                 s = name.to_s
                 if s.match(/^\d*$/)
                   changesets.where("revision = ?", s).first
                 else
                   changesets.where("revision LIKE ?", s + '%').first
                 end
               end
               def latest_changeset
                 @latest_changeset ||= changesets.first
               end
               # Returns the latest changesets for +path+
               # Default behaviour is to search in cached changesets
               def latest_changesets(path, rev, limit=10)
                 if path.blank?
                   changesets.
                     reorder("#{Changeset.table_name}.committed_on DESC, #{Changeset.table_name}.id DESC").
                     limit(limit).
                     preload(:user).
                     to_a
                 else
                   filechanges.
                     where("path = ?", path.with_leading_slash).
                     reorder("#{Changeset.table_name}.committed_on DESC, #{Changeset.table_name}.id DESC").
                     limit(limit).
                     preload(:changeset => :user).
                     collect(&:changeset)
                 end
               end
               def scan_changesets_for_issue_ids
                 self.changesets.each(&:scan_comment_for_issue_ids)
               end
               # Returns an array of committers usernames and associated user_id
               def committers
                 @committers ||= Changeset.where(:repository_id => id).uniq.pluck(:committer, :user_id)
               end
               # Maps committers username to a user ids
               def committer_ids=(h)
                 if h.is_a?(Hash)
                   committers.each do |committer, user_id|
                     new_user_id = h[committer]
                     if new_user_id && (new_user_id.to_i != user_id.to_i)
                       new_user_id = (new_user_id.to_i > 0 ? new_user_id.to_i : nil)
                       Changeset.where(["repository_id = ? AND committer = ?", id, committer]).
                         update_all("user_id = #{new_user_id.nil? ? 'NULL' : new_user_id}")
                     end
                   end
                   @committers            = nil
                   @found_committer_users = nil
                   true
                 else
                   false
                 end
               end
               # Returns the Redmine User corresponding to the given +committer+
               # It will return nil if the committer is not yet mapped and if no User
               # with the same username or email was found
               def find_committer_user(committer)
                 unless committer.blank?
                   @found_committer_users ||= {}
                   return @found_committer_users[committer] if @found_committer_users.has_key?(committer)
                   user = nil
                   c = changesets.where(:committer => committer).
                         includes(:user).references(:user).first
                   if c && c.user
                     user = c.user
                   elsif committer.strip =~ /^([^<]+)(<(.*)>)?$/
                     username, email = $1.strip, $3
                     u = User.find_by_login(username)
                     u ||= User.find_by_mail(email) unless email.blank?
                     user = u
                   end
                   @found_committer_users[committer] = user
                   user
                 end
               end
               def repo_log_encoding
                 encoding = log_encoding.to_s.strip
                 encoding.blank? ? 'UTF-8' : encoding
               end
               # Fetches new changesets for all repositories of active projects
               # Can be called periodically by an external script
               # eg. ruby script/runner "Repository.fetch_changesets"
               def self.fetch_changesets
                 Project.active.has_module(:repository).all.each do |project|
                   project.repositories.each do |repository|
                     begin
                       repository.fetch_changesets
                     rescue Redmine::Scm::Adapters::CommandFailed => e
                       logger.error "scm: error during fetching changesets: #{e.message}"
                     end
                   end
                 end
               end
               # scan changeset comments to find related and fixed issues for all repositories
               def self.scan_changesets_for_issue_ids
                 all.each(&:scan_changesets_for_issue_ids)
               end
               def self.scm_name
                 'Abstract'
               end
               def self.available_scm
                 subclasses.collect {|klass| [klass.scm_name, klass.name]}
               end
               def self.factory(klass_name, *args)
                 klass = "Repository::#{klass_name}".constantize
                 klass.new(*args)
               rescue
                 nil
               end
               def self.scm_adapter_class
                 nil
               end
               def self.scm_command
                 ret = ""
                 begin
                   ret = self.scm_adapter_class.client_command if self.scm_adapter_class
                 rescue Exception => e
                   logger.error "scm: error during get command: #{e.message}"
                 end
                 ret
               end
               def self.scm_version_string
                 ret = ""
                 begin
                   ret = self.scm_adapter_class.client_version_string if self.scm_adapter_class
                 rescue Exception => e
                   logger.error "scm: error during get version string: #{e.message}"
                 end
                 ret
               end
               def self.scm_available
                 ret = false
                 begin
                   ret = self.scm_adapter_class.client_available if self.scm_adapter_class
                 rescue Exception => e
                   logger.error "scm: error during get scm available: #{e.message}"
                 end
                 ret
               end
               def set_as_default?
                 new_record? && project && Repository.where(:project_id => project.id).empty?
               end
               # Returns a hash with statistics by author in the following form:
               # {
               #   "John Smith" => { :commits => 45, :changes => 324 },
               #   "Bob" => { ... }
               # }
               #
               # Notes:
               # - this hash honnors the users mapping defined for the repository
               def stats_by_author
                 commits = Changeset.where("repository_id = ?", id).select("committer, user_id, count(*) as count").group("committer, user_id")
                 #TODO: restore ordering ; this line probably never worked
                 #commits.to_a.sort! {|x, y| x.last <=> y.last}
                 changes = Change.joins(:changeset).where("#{Changeset.table_name}.repository_id = ?", id).select("committer, user_id, count(*) as count").group("committer, user_id")
                 user_ids = changesets.map(&:user_id).compact.uniq
                 authors_names = User.where(:id => user_ids).inject({}) do |memo, user|
                   memo[user.id] = user.to_s
                   memo
                 end
                 (commits + changes).inject({}) do |hash, element|
                   mapped_name = element.committer
                   if username = authors_names[element.user_id.to_i]
                     mapped_name = username
                   end
                   hash[mapped_name] ||= { :commits_count => 0, :changes_count => 0 }
                   if element.is_a?(Changeset)
                     hash[mapped_name][:commits_count] += element.count.to_i
                   else
                     hash[mapped_name][:changes_count] += element.count.to_i
                   end
                   hash
                 end
               end
               # Returns a scope of changesets that come from the same commit as the given changeset
               # in different repositories that point to the same backend
               def same_commits_in_scope(scope, changeset)
                 scope = scope.joins(:repository).where(:repositories => {:url => url, :root_url => root_url, :type => type})
                 if changeset.scmid.present?
                   scope = scope.where(:scmid => changeset.scmid)
                 else
                   scope = scope.where(:revision => changeset.revision)
                 end
                 scope
               end
               protected
               # Validates repository url based against an optional regular expression
               # that can be set in the Redmine configuration file.
               def validate_repository_path(attribute=:url)
                 regexp = Redmine::Configuration["scm_#{scm_name.to_s.downcase}_path_regexp"]
                 if changes[attribute] && regexp.present?
                   regexp = regexp.to_s.strip.gsub('%project%') {Regexp.escape(project.try(:identifier).to_s)}
                   unless send(attribute).to_s.match(Regexp.new("\\A#{regexp}\\z"))
                     errors.add(attribute, :invalid)
                   end
                 end
               end
               def check_default
                 if !is_default? && set_as_default?
                   self.is_default = true
                 end
                 if is_default? && is_default_changed?
                   Repository.where(["project_id = ?", project_id]).update_all(["is_default = ?", false])
                 end
               end
               def load_entries_changesets(entries)
                 if entries
                   entries.each do |entry|
                     if entry.lastrev && entry.lastrev.identifier
                       entry.changeset = find_changeset_by_name(entry.lastrev.identifier)
                     end
                   end
                 end
               end
               private
               # Deletes repository data
               def clear_changesets
                 cs = Changeset.table_name
                 ch = Change.table_name
                 ci = "#{table_name_prefix}changesets_issues#{table_name_suffix}"
                 cp = "#{table_name_prefix}changeset_parents#{table_name_suffix}"
                 self.class.connection.delete("DELETE FROM #{ch} WHERE #{ch}.changeset_id IN (SELECT #{cs}.id FROM #{cs} WHERE #{cs}.repository_id = #{id})")
                 self.class.connection.delete("DELETE FROM #{ci} WHERE #{ci}.changeset_id IN (SELECT #{cs}.id FROM #{cs} WHERE #{cs}.repository_id = #{id})")
                 self.class.connection.delete("DELETE FROM #{cp} WHERE #{cp}.changeset_id IN (SELECT #{cs}.id FROM #{cs} WHERE #{cs}.repository_id = #{id})")
                 self.class.connection.delete("DELETE FROM #{cs} WHERE #{cs}.repository_id = #{id}")
-                clear_extra_info_of_changesets
-              end
-              def clear_extra_info_of_changesets
               end
             end

app/models/repository/git.rb +6 0

             # Redmine - project management software
             # Copyright (C) 2006-2015  Jean-Philippe Lang
             # Copyright (C) 2007  Patrick Aljord patcito@ŋmail.com
             #
             # 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/git_adapter'
             class Repository::Git < Repository
               attr_protected :root_url
               validates_presence_of :url
               def self.human_attribute_name(attribute_key_name, *args)
                 attr_name = attribute_key_name.to_s
                 if attr_name == "url"
                   attr_name = "path_to_repository"
                 end
                 super(attr_name, *args)
               end
               def self.scm_adapter_class
                 Redmine::Scm::Adapters::GitAdapter
               end
               def self.scm_name
                 'Git'
               end
               def report_last_commit
                 extra_report_last_commit
               end
               def extra_report_last_commit
                 return false if extra_info.nil?
                 v = extra_info["extra_report_last_commit"]
                 return false if v.nil?
                 v.to_s != '0'
               end
               def supports_directory_revisions?
                 true
               end
               def supports_revision_graph?
                 true
               end
               def repo_log_encoding
                 'UTF-8'
               end
               # Returns the identifier for the given git changeset
               def self.changeset_identifier(changeset)
                 changeset.scmid
               end
               # Returns the readable identifier for the given git changeset
               def self.format_changeset_identifier(changeset)
                 changeset.revision[0, 8]
               end
               def branches
                 scm.branches
               end
               def tags
                 scm.tags
               end
               def default_branch
                 scm.default_branch
               rescue Exception => e
                 logger.error "git: error during get default branch: #{e.message}"
                 nil
               end
               def find_changeset_by_name(name)
                 if name.present?
                   changesets.where(:revision => name.to_s).first ||
                     changesets.where('scmid LIKE ?', "#{name}%").first
                 end
               end
               def scm_entries(path=nil, identifier=nil)
                 scm.entries(path, identifier, :report_last_commit => extra_report_last_commit)
               end
               protected :scm_entries
               # With SCMs that have a sequential commit numbering,
               # such as Subversion and Mercurial,
               # Redmine is able to be clever and only fetch changesets
               # going forward from the most recent one it knows about.
               #
               # However, Git does not have a sequential commit numbering.
               #
               # In order to fetch only new adding revisions,
               # Redmine needs to save "heads".
               #
               # In Git and Mercurial, revisions are not in date order.
               # Redmine Mercurial fixed issues.
               #    * Redmine Takes Too Long On Large Mercurial Repository
               #      http://www.redmine.org/issues/3449
               #    * Sorting for changesets might go wrong on Mercurial repos
               #      http://www.redmine.org/issues/3567
               #
               # Database revision column is text, so Redmine can not sort by revision.
               # Mercurial has revision number, and revision number guarantees revision order.
               # Redmine Mercurial model stored revisions ordered by database id to database.
               # So, Redmine Mercurial model can use correct ordering revisions.
               #
               # Redmine Mercurial adapter uses "hg log -r 0:tip --limit 10"
               # to get limited revisions from old to new.
               # But, Git 1.7.3.4 does not support --reverse with -n or --skip.
               #
               # The repository can still be fully reloaded by calling #clear_changesets
               # before fetching changesets (eg. for offline resync)
               def fetch_changesets
                 scm_brs = branches
                 return if scm_brs.nil? || scm_brs.empty?
                 h1 = extra_info || {}
                 h  = h1.dup
                 repo_heads = scm_brs.map{ |br| br.scmid }
                 h["heads"] ||= []
                 prev_db_heads = h["heads"].dup
                 if prev_db_heads.empty?
                   prev_db_heads += heads_from_branches_hash
                 end
                 return if prev_db_heads.sort == repo_heads.sort
                 h["db_consistent"]  ||= {}
                 if changesets.count == 0
                   h["db_consistent"]["ordering"] = 1
                   merge_extra_info(h)
                   self.save
                 elsif ! h["db_consistent"].has_key?("ordering")
                   h["db_consistent"]["ordering"] = 0
                   merge_extra_info(h)
                   self.save
                 end
                 save_revisions(prev_db_heads, repo_heads)
               end
               def save_revisions(prev_db_heads, repo_heads)
                 h = {}
                 opts = {}
                 opts[:reverse]  = true
                 opts[:excludes] = prev_db_heads
                 opts[:includes] = repo_heads
                 revisions = scm.revisions('', nil, nil, opts)
                 return if revisions.blank?
                 # Make the search for existing revisions in the database in a more sufficient manner
                 #
                 # Git branch is the reference to the specific revision.
                 # Git can *delete* remote branch and *re-push* branch.
                 #
                 #  $ git push remote :branch
                 #  $ git push remote branch
                 #
                 # After deleting branch, revisions remain in repository until "git gc".
                 # On git 1.7.2.3, default pruning date is 2 weeks.
                 # So, "git log --not deleted_branch_head_revision" return code is 0.
                 #
                 # After re-pushing branch, "git log" returns revisions which are saved in database.
                 # So, Redmine needs to scan revisions and database every time.
                 #
                 # This is replacing the one-after-one queries.
                 # Find all revisions, that are in the database, and then remove them
                 # from the revision array.
                 # Then later we won't need any conditions for db existence.
                 # Query for several revisions at once, and remove them
                 # from the revisions array, if they are there.
                 # Do this in chunks, to avoid eventual memory problems
                 # (in case of tens of thousands of commits).
                 # If there are no revisions (because the original code's algorithm filtered them),
                 # then this part will be stepped over.
                 # We make queries, just if there is any revision.
                 limit = 100
                 offset = 0
                 revisions_copy = revisions.clone # revisions will change
                 while offset < revisions_copy.size
                   scmids = revisions_copy.slice(offset, limit).map{|x| x.scmid}
                   recent_changesets_slice = changesets.where(:scmid => scmids)
                   # Subtract revisions that redmine already knows about
                   recent_revisions = recent_changesets_slice.map{|c| c.scmid}
                   revisions.reject!{|r| recent_revisions.include?(r.scmid)}
                   offset += limit
                 end
                 revisions.each do |rev|
                   transaction do
                     # There is no search in the db for this revision, because above we ensured,
                     # that it's not in the db.
                     save_revision(rev)
                   end
                 end
                 h["heads"] = repo_heads.dup
                 merge_extra_info(h)
                 self.save
               end
               private :save_revisions
               def save_revision(rev)
                 parents = (rev.parents || []).collect{|rp| find_changeset_by_name(rp)}.compact
                 changeset = Changeset.create(
                           :repository   => self,
                           :revision     => rev.identifier,
                           :scmid        => rev.scmid,
                           :committer    => rev.author,
                           :committed_on => rev.time,
                           :comments     => rev.message,
                           :parents      => parents
                           )
                 unless changeset.new_record?
                   rev.paths.each { |change| changeset.create_change(change) }
                 end
                 changeset
               end
               private :save_revision
               def heads_from_branches_hash
                 h1 = extra_info || {}
                 h  = h1.dup
                 h["branches"] ||= {}
                 h['branches'].map{|br, hs| hs['last_scmid']}
               end
               def latest_changesets(path,rev,limit=10)
                 revisions = scm.revisions(path, nil, rev, :limit => limit, :all => false)
                 return [] if revisions.nil? || revisions.empty?
                 changesets.where(:scmid => revisions.map {|c| c.scmid}).to_a
               end
               def clear_extra_info_of_changesets
                 return if extra_info.nil?
                 v = extra_info["extra_report_last_commit"]
                 write_attribute(:extra_info, nil)
                 h = {}
                 h["extra_report_last_commit"] = v
                 merge_extra_info(h)
                 self.save
               end
               private :clear_extra_info_of_changesets
+              def clear_changesets
+                super
+                clear_extra_info_of_changesets
+              end
+              private :clear_changesets
             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