jro_apps/redmine Commit - r13520:9915962356ce

Make sure that #scm_iconv returns a string with the target encoding (#14534)....

Jean-Philippe Lang -

r13520:9915962356ce

parent child

Context file:

r13520:9915962356ce

Collapse all files

lib/redmine/scm/adapters/abstract_adapter.rb +1 -1

             # 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.
             require 'cgi'
             require 'redmine/scm/adapters'
             module Redmine
               module Scm
                 module Adapters
                   class AbstractAdapter #:nodoc:
                     # raised if scm command exited with error, e.g. unknown revision.
                     class ScmCommandAborted < ::Redmine::Scm::Adapters::CommandFailed; end
                     class << self
                       def client_command
                         ""
                       end
                       def shell_quote_command
                         if Redmine::Platform.mswin? && RUBY_PLATFORM == 'java'
                           client_command
                         else
                           shell_quote(client_command)
                         end
                       end
                       # Returns the version of the scm client
                       # Eg: [1, 5, 0] or [] if unknown
                       def client_version
                         []
                       end
                       # Returns the version string of the scm client
                       # Eg: '1.5.0' or 'Unknown version' if unknown
                       def client_version_string
                         v = client_version || 'Unknown version'
                         v.is_a?(Array) ? v.join('.') : v.to_s
                       end
                       # Returns true if the current client version is above
                       # or equals the given one
                       # If option is :unknown is set to true, it will return
                       # true if the client version is unknown
                       def client_version_above?(v, options={})
                         ((client_version <=> v) >= 0) || (client_version.empty? && options[:unknown])
                       end
                       def client_available
                         true
                       end
                       def shell_quote(str)
                         if Redmine::Platform.mswin?
                           '"' + str.gsub(/"/, '\\"') + '"'
                         else
                           "'" + str.gsub(/'/, "'\"'\"'") + "'"
                         end
                       end
                     end
                     def initialize(url, root_url=nil, login=nil, password=nil,
                                    path_encoding=nil)
                       @url = url
                       @login = login if login && !login.empty?
                       @password = (password || "") if @login
                       @root_url = root_url.blank? ? retrieve_root_url : root_url
                     end
                     def adapter_name
                       'Abstract'
                     end
                     def supports_cat?
                       true
                     end
                     def supports_annotate?
                       respond_to?('annotate')
                     end
                     def root_url
                       @root_url
                     end
                     def url
                       @url
                     end
                     def path_encoding
                       nil
                     end
                     # get info about the svn repository
                     def info
                       return nil
                     end
                     # Returns the entry identified by path and revision identifier
                     # or nil if entry doesn't exist in the repository
                     def entry(path=nil, identifier=nil)
                       parts = path.to_s.split(%r{[\/\\]}).select {|n| !n.blank?}
                       search_path = parts[0..-2].join('/')
                       search_name = parts[-1]
                       if search_path.blank? && search_name.blank?
                         # Root entry
                         Entry.new(:path => '', :kind => 'dir')
                       else
                         # Search for the entry in the parent directory
                         es = entries(search_path, identifier)
                         es ? es.detect {|e| e.name == search_name} : nil
                       end
                     end
                     # Returns an Entries collection
                     # or nil if the given path doesn't exist in the repository
                     def entries(path=nil, identifier=nil, options={})
                       return nil
                     end
                     def branches
                       return nil
                     end
                     def tags
                       return nil
                     end
                     def default_branch
                       return nil
                     end
                     def properties(path, identifier=nil)
                       return nil
                     end
                     def revisions(path=nil, identifier_from=nil, identifier_to=nil, options={})
                       return nil
                     end
                     def diff(path, identifier_from, identifier_to=nil)
                       return nil
                     end
                     def cat(path, identifier=nil)
                       return nil
                     end
                     def with_leading_slash(path)
                       path ||= ''
                       (path[0,1]!="/") ? "/#{path}" : path
                     end
                     def with_trailling_slash(path)
                       path ||= ''
                       (path[-1,1] == "/") ? path : "#{path}/"
                     end
                     def without_leading_slash(path)
                       path ||= ''
                       path.gsub(%r{^/+}, '')
                     end
                     def without_trailling_slash(path)
                       path ||= ''
                       (path[-1,1] == "/") ? path[0..-2] : path
                     end
                     def shell_quote(str)
                       self.class.shell_quote(str)
                     end
                   private
                     def retrieve_root_url
                       info = self.info
                       info ? info.root_url : nil
                     end
                     def target(path, sq=true)
                       path ||= ''
                       base = path.match(/^\//) ? root_url : url
                       str = "#{base}/#{path}".gsub(/[?<>\*]/, '')
                       if sq
                         str = shell_quote(str)
                       end
                       str
                     end
                     def logger
                       self.class.logger
                     end
                     def shellout(cmd, options = {}, &block)
                       self.class.shellout(cmd, options, &block)
                     end
                     def self.logger
                       Rails.logger
                     end
                     # Path to the file where scm stderr output is logged
                     # Returns nil if the log file is not writable
                     def self.stderr_log_file
                       if @stderr_log_file.nil?
                         writable = false
                         path = Redmine::Configuration['scm_stderr_log_file'].presence
                         path ||= Rails.root.join("log/#{Rails.env}.scm.stderr.log").to_s
                         if File.exists?(path)
                           if File.file?(path) && File.writable?(path)
                             writable = true
                           else
                             logger.warn("SCM log file (#{path}) is not writable")
                           end
                         else
                           begin
                             File.open(path, "w") {}
                             writable = true
                           rescue => e
                             logger.warn("SCM log file (#{path}) cannot be created: #{e.message}")
                           end
                         end
                         @stderr_log_file = writable ? path : false
                       end
                       @stderr_log_file || nil
                     end
                     def self.shellout(cmd, options = {}, &block)
                       if logger && logger.debug?
                         logger.debug "Shelling out: #{strip_credential(cmd)}"
                         # Capture stderr in a log file
                         if stderr_log_file
                           cmd = "#{cmd} 2>>#{shell_quote(stderr_log_file)}"
                         end
                       end
                       begin
                         mode = "r+"
                         IO.popen(cmd, mode) do |io|
                           io.set_encoding("ASCII-8BIT") if io.respond_to?(:set_encoding)
                           io.close_write unless options[:write_stdin]
                           block.call(io) if block_given?
                         end
                       ## If scm command does not exist,
                       ## Linux JRuby 1.6.2 (ruby-1.8.7-p330) raises java.io.IOException
                       ## in production environment.
                       # rescue Errno::ENOENT => e
                       rescue Exception => e
                         msg = strip_credential(e.message)
                         # The command failed, log it and re-raise
                         logmsg = "SCM command failed, "
                         logmsg += "make sure that your SCM command (e.g. svn) is "
                         logmsg += "in PATH (#{ENV['PATH']})\n"
                         logmsg += "You can configure your scm commands in config/configuration.yml.\n"
                         logmsg += "#{strip_credential(cmd)}\n"
                         logmsg += "with: #{msg}"
                         logger.error(logmsg)
                         raise CommandFailed.new(msg)
                       end
                     end
                     # Hides username/password in a given command
                     def self.strip_credential(cmd)
                       q = (Redmine::Platform.mswin? ? '"' : "'")
                       cmd.to_s.gsub(/(\-\-(password|username))\s+(#{q}[^#{q}]+#{q}|[^#{q}]\S+)/, '\\1 xxxx')
                     end
                     def strip_credential(cmd)
                       self.class.strip_credential(cmd)
                     end
                     def scm_iconv(to, from, str)
                       return nil if str.nil?
-                      return str if to == from
+                      return str if to == from && str.encoding.to_s == from
                       str.force_encoding(from)
                       begin
                         str.encode(to)
                       rescue Exception => err
                         logger.error("failed to convert from #{from} to #{to}. #{err}")
                         nil
                       end
                     end
                     def parse_xml(xml)
                       if RUBY_PLATFORM == 'java'
                         xml = xml.sub(%r{<\?xml[^>]*\?>}, '')
                       end
                       ActiveSupport::XmlMini.parse(xml)
                     end
                   end
                   class Entries < Array
                     def sort_by_name
                       dup.sort! {|x,y|
                         if x.kind == y.kind
                           x.name.to_s <=> y.name.to_s
                         else
                           x.kind <=> y.kind
                         end
                       }
                     end
                     def revisions
                       revisions ||= Revisions.new(collect{|entry| entry.lastrev}.compact)
                     end
                   end
                   class Info
                     attr_accessor :root_url, :lastrev
                     def initialize(attributes={})
                       self.root_url = attributes[:root_url] if attributes[:root_url]
                       self.lastrev = attributes[:lastrev]
                     end
                   end
                   class Entry
                     attr_accessor :name, :path, :kind, :size, :lastrev, :changeset
                     def initialize(attributes={})
                       self.name = attributes[:name] if attributes[:name]
                       self.path = attributes[:path] if attributes[:path]
                       self.kind = attributes[:kind] if attributes[:kind]
                       self.size = attributes[:size].to_i if attributes[:size]
                       self.lastrev = attributes[:lastrev]
                     end
                     def is_file?
                       'file' == self.kind
                     end
                     def is_dir?
                       'dir' == self.kind
                     end
                     def is_text?
                       Redmine::MimeType.is_type?('text', name)
                     end
                     def author
                       if changeset
                         changeset.author.to_s
                       elsif lastrev
                         Redmine::CodesetUtil.replace_invalid_utf8(lastrev.author.to_s.split('<').first)
                       end
                     end
                   end
                   class Revisions < Array
                     def latest
                       sort {|x,y|
                         unless x.time.nil? or y.time.nil?
                           x.time <=> y.time
                         else
                         end
                       }.last
                     end
                   end
                   class Revision
                     attr_accessor :scmid, :name, :author, :time, :message,
                                   :paths, :revision, :branch, :identifier,
                                   :parents
                     def initialize(attributes={})
                       self.identifier = attributes[:identifier]
                       self.scmid      = attributes[:scmid]
                       self.name       = attributes[:name] || self.identifier
                       self.author     = attributes[:author]
                       self.time       = attributes[:time]
                       self.message    = attributes[:message] || ""
                       self.paths      = attributes[:paths]
                       self.revision   = attributes[:revision]
                       self.branch     = attributes[:branch]
                       self.parents    = attributes[:parents]
                     end
                     # Returns the readable identifier.
                     def format_identifier
                       self.identifier.to_s
                     end
                     def ==(other)
                       if other.nil?
                         false
                       elsif scmid.present?
                         scmid == other.scmid
                       elsif identifier.present?
                         identifier == other.identifier
                       elsif revision.present?
                         revision == other.revision
                       end
                     end
                   end
                   class Annotate
                     attr_reader :lines, :revisions
                     def initialize
                       @lines = []
                       @revisions = []
                     end
                     def add_line(line, revision)
                       @lines << line
                       @revisions << revision
                     end
                     def content
                       content = lines.join("\n")
                     end
                     def empty?
                       lines.empty?
                     end
                   end
                   class Branch < String
                     attr_accessor :revision, :scmid
                   end
                 end
               end
             end

test/unit/repository_cvs_test.rb +1 0

             # 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.
             require File.expand_path('../../test_helper', __FILE__)
             require 'pp'
             class RepositoryCvsTest < ActiveSupport::TestCase
               fixtures :projects
               include Redmine::I18n
               REPOSITORY_PATH = repository_path('cvs')
               REPOSITORY_PATH.gsub!(/\//, "\\") if Redmine::Platform.mswin?
               # CVS module
               MODULE_NAME    = 'test'
               CHANGESETS_NUM = 7
               def setup
                 @project = Project.find(3)
                 @repository = Repository::Cvs.create(:project  => @project,
                                                      :root_url => REPOSITORY_PATH,
                                                      :url      => MODULE_NAME,
                                                      :log_encoding => 'UTF-8')
                 assert @repository
               end
               def test_blank_module_error_message
                 set_language_if_valid 'en'
                 repo = Repository::Cvs.new(
                                       :project      => @project,
                                       :identifier   => 'test',
                                       :log_encoding => 'UTF-8',
                                       :root_url     => REPOSITORY_PATH
                                     )
                 assert !repo.save
                 assert_include "Module cannot be blank",
                                repo.errors.full_messages
               end
               def test_blank_module_error_message_fr
                 set_language_if_valid 'fr'
                 str = "Module doit \xc3\xaatre renseign\xc3\xa9(e)".force_encoding('UTF-8')
                 repo = Repository::Cvs.new(
                                       :project       => @project,
                                       :identifier    => 'test',
                                       :log_encoding  => 'UTF-8',
                                       :path_encoding => '',
                                       :url           => '',
                                       :root_url      => REPOSITORY_PATH
                                     )
                 assert !repo.save
                 assert_include str, repo.errors.full_messages
               end
               def test_blank_cvsroot_error_message
                 set_language_if_valid 'en'
                 repo = Repository::Cvs.new(
                                       :project      => @project,
                                       :identifier   => 'test',
                                       :log_encoding => 'UTF-8',
                                       :url          => MODULE_NAME
                                     )
                 assert !repo.save
                 assert_include "CVSROOT cannot be blank",
                                repo.errors.full_messages
               end
               def test_blank_cvsroot_error_message_fr
                 set_language_if_valid 'fr'
                 str = "CVSROOT doit \xc3\xaatre renseign\xc3\xa9(e)".force_encoding('UTF-8')
                 repo = Repository::Cvs.new(
                                       :project       => @project,
                                       :identifier    => 'test',
                                       :log_encoding  => 'UTF-8',
                                       :path_encoding => '',
                                       :url           => MODULE_NAME,
                                       :root_url      => ''
                                     )
                 assert !repo.save
                 assert_include str, repo.errors.full_messages
               end
               def test_root_url_should_be_validated_against_regexp_set_in_configuration
                 Redmine::Configuration.with 'scm_cvs_path_regexp' => '/cvspath/[a-z]+' do
                   repo = Repository::Cvs.new(
                     :project       => @project,
                     :identifier    => 'test',
                     :log_encoding  => 'UTF-8',
                     :path_encoding => '',
                     :url           => MODULE_NAME
                   )
                   repo.root_url = '/wrong_path'
                   assert !repo.valid?
                   assert repo.errors[:root_url].present?
                   repo.root_url = '/cvspath/foo'
                   assert repo.valid?
                 end
               end
               if File.directory?(REPOSITORY_PATH)
                 def test_fetch_changesets_from_scratch
                   assert_equal 0, @repository.changesets.count
                   @repository.fetch_changesets
                   @project.reload
                   assert_equal CHANGESETS_NUM, @repository.changesets.count
                   assert_equal 16, @repository.filechanges.count
                   assert_not_nil @repository.changesets.find_by_comments('Two files changed')
                   r2 = @repository.changesets.find_by_revision('2')
                   assert_equal 'v1-20071213-162510', r2.scmid
                 end
                 def test_fetch_changesets_incremental
                   assert_equal 0, @repository.changesets.count
                   @repository.fetch_changesets
                   @project.reload
                   assert_equal CHANGESETS_NUM, @repository.changesets.count
                   # Remove changesets with revision > 3
                   @repository.changesets.each {|c| c.destroy if c.revision.to_i > 3}
                   @project.reload
                   @repository.reload
                   assert_equal 3, @repository.changesets.count
                   assert_equal %w|3 2 1|, @repository.changesets.collect(&:revision)
                   rev3_commit = @repository.changesets.reorder('committed_on DESC').first
                   assert_equal '3', rev3_commit.revision
                    # 2007-12-14 01:27:22 +0900
                   rev3_committed_on = Time.gm(2007, 12, 13, 16, 27, 22)
                   assert_equal 'HEAD-20071213-162722', rev3_commit.scmid
                   assert_equal rev3_committed_on, rev3_commit.committed_on
                   latest_rev = @repository.latest_changeset
                   assert_equal rev3_committed_on, latest_rev.committed_on
                   @repository.fetch_changesets
                   @project.reload
                   @repository.reload
                   assert_equal CHANGESETS_NUM, @repository.changesets.count
                   assert_equal %w|7 6 5 4 3 2 1|, @repository.changesets.collect(&:revision)
                   rev5_commit = @repository.changesets.find_by_revision('5')
                   assert_equal 'HEAD-20071213-163001', rev5_commit.scmid
                    # 2007-12-14 01:30:01 +0900
                   rev5_committed_on = Time.gm(2007, 12, 13, 16, 30, 1)
                   assert_equal rev5_committed_on, rev5_commit.committed_on
                 end
                 def test_deleted_files_should_not_be_listed
                   assert_equal 0, @repository.changesets.count
                   @repository.fetch_changesets
                   @project.reload
                   assert_equal CHANGESETS_NUM, @repository.changesets.count
                   entries = @repository.entries('sources')
                   assert entries.detect {|e| e.name == 'watchers_controller.rb'}
                   assert_nil entries.detect {|e| e.name == 'welcome_controller.rb'}
                 end
                 def test_entries_rev3
                   assert_equal 0, @repository.changesets.count
                   @repository.fetch_changesets
                   @project.reload
                   assert_equal CHANGESETS_NUM, @repository.changesets.count
                   entries = @repository.entries('', '3')
                   assert_kind_of Redmine::Scm::Adapters::Entries, entries
                   assert_equal 3, entries.size
                   assert_equal entries[2].name, "README"
+                  assert_equal 'UTF-8', entries[2].path.encoding.to_s
                   assert_equal entries[2].lastrev.time, Time.gm(2007, 12, 13, 16, 27, 22)
                   assert_equal entries[2].lastrev.identifier, '3'
                   assert_equal entries[2].lastrev.revision, '3'
                   assert_equal entries[2].lastrev.author, 'LANG'
                 end
                 def test_entries_invalid_path
                   assert_equal 0, @repository.changesets.count
                   @repository.fetch_changesets
                   @project.reload
                   assert_equal CHANGESETS_NUM, @repository.changesets.count
                   assert_nil @repository.entries('missing')
                   assert_nil @repository.entries('missing', '3')
                 end
                 def test_entries_invalid_revision
                   assert_equal 0, @repository.changesets.count
                   @repository.fetch_changesets
                   @project.reload
                   assert_equal CHANGESETS_NUM, @repository.changesets.count
                   assert_nil @repository.entries('', '123')
                 end
                 def test_cat
                   assert_equal 0, @repository.changesets.count
                   @repository.fetch_changesets
                   @project.reload
                   assert_equal CHANGESETS_NUM, @repository.changesets.count
                   buf = @repository.cat('README')
                   assert buf
                   lines = buf.split("\n")
                   assert_equal 3, lines.length
                   buf = lines[1].gsub(/\r$/, "")
                   assert_equal 'with one change', buf
                   buf = @repository.cat('README', '1')
                   assert buf
                   lines = buf.split("\n")
                   assert_equal 1, lines.length
                   buf = lines[0].gsub(/\r$/, "")
                   assert_equal 'CVS test repository', buf
                   assert_nil @repository.cat('missing.rb')
                   # sources/welcome_controller.rb is removed at revision 5.
                   assert @repository.cat('sources/welcome_controller.rb', '4')
                   assert @repository.cat('sources/welcome_controller.rb', '5').blank?
                   # invalid revision
                   assert @repository.cat('README', '123').blank?
                 end
                 def test_annotate
                   assert_equal 0, @repository.changesets.count
                   @repository.fetch_changesets
                   @project.reload
                   assert_equal CHANGESETS_NUM, @repository.changesets.count
                   ann = @repository.annotate('README')
                   assert ann
                   assert_equal 3, ann.revisions.length
                   assert_equal '1.2', ann.revisions[1].revision
                   assert_equal 'LANG', ann.revisions[1].author
                   assert_equal 'with one change', ann.lines[1]
                   ann = @repository.annotate('README', '1')
                   assert ann
                   assert_equal 1, ann.revisions.length
                   assert_equal '1.1', ann.revisions[0].revision
                   assert_equal 'LANG', ann.revisions[0].author
                   assert_equal 'CVS test repository', ann.lines[0]
                  # invalid revision
                  assert_nil @repository.annotate('README', '123')
                end
               else
                 puts "CVS test repository NOT FOUND. Skipping unit tests !!!"
                 def test_fake; assert true end
               end
             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