jro_apps/redmine Commit - r4701:8b98c05879a2

scm: use shell quote for scm command at adapter level (#7517, #4273)....

Toshi MARUYAMA -

r4701:8b98c05879a2

parent child

Context file:

r4701:8b98c05879a2

Collapse all files

config/configuration.yml.example +1 -1

               # Absolute path (e.g. /usr/local/bin/hg) or command name (e.g. hg.exe, bzr.exe)
               # On Windows, *.cmd, *.bat (e.g. hg.cmd, bzr.bat) does not work.
               scm_subversion_command: svn                                       # (default: svn)
-              scm_mercurial_command:  "\"C:\Program Files\TortoiseHg\hg.exe\""  # (default: hg)
+              scm_mercurial_command:  C:\Program Files\TortoiseHg\hg.exe        # (default: hg)
               scm_git_command:        /usr/local/bin/git                        # (default: git)
               scm_cvs_command:        cvs                                       # (default: cvs)
               scm_bazaar_command:     bzr.exe                                   # (default: bzr)

lib/redmine/scm/adapters/abstract_adapter.rb +17 -5

                   class AbstractAdapter #:nodoc:
                     class << self
+                      def client_command
+                        ""
+                      end
                       # Returns the version of the scm client
                       # Eg: [1, 5, 0] or [] if unknown
                       def client_version
                       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)
                      end
                     def shell_quote(str)
-                      if Redmine::Platform.mswin?
+                      self.class.shell_quote(str)
-                        '"' + str.gsub(/"/, '\\"') + '"'
-                      else
-                        "'" + str.gsub(/'/, "'\"'\"'") + "'"
-                      end
                     end
                   private

lib/redmine/scm/adapters/bazaar_adapter.rb +16 -6

                     # Bazaar executable name
                     BZR_BIN = Redmine::Configuration['scm_bazaar_command'] || "bzr"
+                    class << self
+                      def client_command
+                        @@bin    ||= BZR_BIN
+                      end
+                      def sq_bin
+                        @@sq_bin ||= shell_quote(BZR_BIN)
+                      end
+                    end
                     # Get info about the repository
                     def info
-                      cmd = "#{BZR_BIN} revno #{target('')}"
+                      cmd = "#{self.class.sq_bin} revno #{target('')}"
                       info = nil
                       shellout(cmd) do |io|
                         if io.read =~ %r{^(\d+)\r?$}
                     def entries(path=nil, identifier=nil)
                       path ||= ''
                       entries = Entries.new
-                      cmd = "#{BZR_BIN} ls -v --show-ids"
+                      cmd = "#{self.class.sq_bin} ls -v --show-ids"
                       identifier = -1 unless identifier && identifier.to_i > 0
                       cmd << " -r#{identifier.to_i}"
                       cmd << " #{target(path)}"
                       identifier_from = (identifier_from and identifier_from.to_i > 0) ? identifier_from.to_i : 'last:1'
                       identifier_to = (identifier_to and identifier_to.to_i > 0) ? identifier_to.to_i : 1
                       revisions = Revisions.new
-                      cmd = "#{BZR_BIN} log -v --show-ids -r#{identifier_to}..#{identifier_from} #{target(path)}"
+                      cmd = "#{self.class.sq_bin} log -v --show-ids -r#{identifier_to}..#{identifier_from} #{target(path)}"
                       shellout(cmd) do |io|
                         revision = nil
                         parsing = nil
                       if identifier_from
                         identifier_from = identifier_from.to_i
                       end
-                      cmd = "#{BZR_BIN} diff -r#{identifier_to}..#{identifier_from} #{target(path)}"
+                      cmd = "#{self.class.sq_bin} diff -r#{identifier_to}..#{identifier_from} #{target(path)}"
                       diff = []
                       shellout(cmd) do |io|
                         io.each_line do |line|
                     end
                     def cat(path, identifier=nil)
-                      cmd = "#{BZR_BIN} cat"
+                      cmd = "#{self.class.sq_bin} cat"
                       cmd << " -r#{identifier.to_i}" if identifier && identifier.to_i > 0
                       cmd << " #{target(path)}"
                       cat = nil
                     end
                     def annotate(path, identifier=nil)
-                      cmd = "#{BZR_BIN} annotate --all"
+                      cmd = "#{self.class.sq_bin} annotate --all"
                       cmd << " -r#{identifier.to_i}" if identifier && identifier.to_i > 0
                       cmd << " #{target(path)}"
                       blame = Annotate.new

lib/redmine/scm/adapters/cvs_adapter.rb +15 -5

                     # CVS executable name
                     CVS_BIN = Redmine::Configuration['scm_cvs_command'] || "cvs"
+                    class << self
+                      def client_command
+                        @@bin    ||= CVS_BIN
+                      end
+                      def sq_bin
+                        @@sq_bin ||= shell_quote(CVS_BIN)
+                      end
+                    end
                     # Guidelines for the input:
                     #  url -> the project-path, relative to the cvsroot (eg. module name)
                     #  root_url -> the good old, sometimes damned, CVSROOT
                       logger.debug "<cvs> entries '#{path}' with identifier '#{identifier}'"
                       path_with_project="#{url}#{with_leading_slash(path)}"
                       entries = Entries.new
-                      cmd = "#{CVS_BIN} -d #{shell_quote root_url} rls -e"
+                      cmd = "#{self.class.sq_bin} -d #{shell_quote root_url} rls -e"
                       cmd << " -D \"#{time_to_cvstime(identifier)}\"" if identifier
                       cmd << " #{shell_quote path_with_project}"
                       shellout(cmd) do |io|
                       logger.debug "<cvs> revisions path:'#{path}',identifier_from #{identifier_from}, identifier_to #{identifier_to}"
                       path_with_project="#{url}#{with_leading_slash(path)}"
-                      cmd = "#{CVS_BIN} -d #{shell_quote root_url} rlog"
+                      cmd = "#{self.class.sq_bin} -d #{shell_quote root_url} rlog"
                       cmd << " -d\">#{time_to_cvstime_rlog(identifier_from)}\"" if identifier_from
                       cmd << " #{shell_quote path_with_project}"
                       shellout(cmd) do |io|
                     def diff(path, identifier_from, identifier_to=nil)
                       logger.debug "<cvs> diff path:'#{path}',identifier_from #{identifier_from}, identifier_to #{identifier_to}"
                       path_with_project="#{url}#{with_leading_slash(path)}"
-                      cmd = "#{CVS_BIN} -d #{shell_quote root_url} rdiff -u -r#{identifier_to} -r#{identifier_from} #{shell_quote path_with_project}"
+                      cmd = "#{self.class.sq_bin} -d #{shell_quote root_url} rdiff -u -r#{identifier_to} -r#{identifier_from} #{shell_quote path_with_project}"
                       diff = []
                       shellout(cmd) do |io|
                         io.each_line do |line|
                       identifier = (identifier) ? identifier : "HEAD"
                       logger.debug "<cvs> cat path:'#{path}',identifier #{identifier}"
                       path_with_project="#{url}#{with_leading_slash(path)}"
-                      cmd = "#{CVS_BIN} -d #{shell_quote root_url} co"
+                      cmd = "#{self.class.sq_bin} -d #{shell_quote root_url} co"
                       cmd << " -D \"#{time_to_cvstime(identifier)}\"" if identifier
                       cmd << " -p #{shell_quote path_with_project}"
                       cat = nil
                       identifier = (identifier) ? identifier.to_i : "HEAD"
                       logger.debug "<cvs> annotate path:'#{path}',identifier #{identifier}"
                       path_with_project="#{url}#{with_leading_slash(path)}"
-                      cmd = "#{CVS_BIN} -d #{shell_quote root_url} rannotate -r#{identifier} #{shell_quote path_with_project}"
+                      cmd = "#{self.class.sq_bin} -d #{shell_quote root_url} rannotate -r#{identifier} #{shell_quote path_with_project}"
                       blame = Annotate.new
                       shellout(cmd) do |io|
                         io.each_line do |line|

lib/redmine/scm/adapters/darcs_adapter.rb +14 -6

                     DARCS_BIN = Redmine::Configuration['scm_darcs_command'] || "darcs"
                     class << self
+                      def client_command
+                        @@bin    ||= DARCS_BIN
+                      end
+                      def sq_bin
+                        @@sq_bin ||= shell_quote(DARCS_BIN)
+                      end
                       def client_version
                         @@client_version ||= (darcs_binary_version || [])
                       end
                       end
                       def darcs_binary_version_from_command_line
-                        shellout("#{DARCS_BIN} --version") { |io| io.read }.to_s
+                        shellout("#{sq_bin} --version") { |io| io.read }.to_s
                       end
                     end
                         path = ( self.class.client_version_above?([2, 2, 0]) ? @url : '.' )
                       end
                       entries = Entries.new
-                      cmd = "#{DARCS_BIN} annotate --repodir #{shell_quote @url} --xml-output"
+                      cmd = "#{self.class.sq_bin} annotate --repodir #{shell_quote @url} --xml-output"
                       cmd << " --match #{shell_quote("hash #{identifier}")}" if identifier
                       cmd << " #{shell_quote path}"
                       shellout(cmd) do |io|
                     def revisions(path=nil, identifier_from=nil, identifier_to=nil, options={})
                       path = '.' if path.blank?
                       revisions = Revisions.new
-                      cmd = "#{DARCS_BIN} changes --repodir #{shell_quote @url} --xml-output"
+                      cmd = "#{self.class.sq_bin} changes --repodir #{shell_quote @url} --xml-output"
                       cmd << " --from-match #{shell_quote("hash #{identifier_from}")}" if identifier_from
                       cmd << " --last #{options[:limit].to_i}" if options[:limit]
                       shellout(cmd) do |io|
                     def diff(path, identifier_from, identifier_to=nil)
                       path = '*' if path.blank?
-                      cmd = "#{DARCS_BIN} diff --repodir #{shell_quote @url}"
+                      cmd = "#{self.class.sq_bin} diff --repodir #{shell_quote @url}"
                       if identifier_to.nil?
                         cmd << " --match #{shell_quote("hash #{identifier_from}")}"
                       else
                     end
                     def cat(path, identifier=nil)
-                      cmd = "#{DARCS_BIN} show content --repodir #{shell_quote @url}"
+                      cmd = "#{self.class.sq_bin} show content --repodir #{shell_quote @url}"
                       cmd << " --match #{shell_quote("hash #{identifier}")}" if identifier
                       cmd << " #{shell_quote path}"
                       cat = nil
                     # Retrieve changed paths for a single patch
                     def get_paths_for_patch_raw(hash)
-                      cmd = "#{DARCS_BIN} annotate --repodir #{shell_quote @url} --summary --xml-output"
+                      cmd = "#{self.class.sq_bin} annotate --repodir #{shell_quote @url} --summary --xml-output"
                       cmd << " --match #{shell_quote("hash #{hash}")} "
                       paths = []
                       shellout(cmd) do |io|

lib/redmine/scm/adapters/filesystem_adapter.rb +5 0

                 module Adapters
                   class FilesystemAdapter < AbstractAdapter
+                    class << self
+                      def client_available
+                        true
+                      end
+                    end
                     def initialize(url, root_url=nil, login=nil, password=nil)
                       @url = with_trailling_slash(url)

lib/redmine/scm/adapters/git_adapter.rb +23 -9

                     # Git executable name
                     GIT_BIN = Redmine::Configuration['scm_git_command'] || "git"
+                    class << self
+                      def client_command
+                        @@bin    ||= GIT_BIN
+                      end
+                      def sq_bin
+                        @@sq_bin ||= shell_quote(GIT_BIN)
+                      end
+                      def client_available
+                        !client_version.empty?
+                      end
+                    end
                     def info
                       begin
                         Info.new(:root_url => url, :lastrev => lastrev('',nil))
                     def branches
                       return @branches if @branches
                       @branches = []
-                      cmd = "#{GIT_BIN} --git-dir #{target('')} branch --no-color"
+                      cmd = "#{self.class.sq_bin} --git-dir #{target('')} branch --no-color"
                       shellout(cmd) do |io|
                         io.each_line do |line|
                           @branches << line.match('\s*\*?\s*(.*)$')[1]
                     def tags
                       return @tags if @tags
-                      cmd = "#{GIT_BIN} --git-dir #{target('')} tag"
+                      cmd = "#{self.class.sq_bin} --git-dir #{target('')} tag"
                       shellout(cmd) do |io|
                         @tags = io.readlines.sort!.map{|t| t.strip}
                       end
                     def entries(path=nil, identifier=nil)
                       path ||= ''
                       entries = Entries.new
-                      cmd = "#{GIT_BIN} --git-dir #{target('')} ls-tree -l "
+                      cmd = "#{self.class.sq_bin} --git-dir #{target('')} ls-tree -l "
                       cmd << shell_quote("HEAD:" + path) if identifier.nil?
                       cmd << shell_quote(identifier + ":" + path) if identifier
                       shellout(cmd)  do |io|
                     def lastrev(path,rev)
                       return nil if path.nil?
-                      cmd = "#{GIT_BIN} --git-dir #{target('')} log --no-color --date=iso --pretty=fuller --no-merges -n 1 "
+                      cmd = "#{self.class.sq_bin} --git-dir #{target('')} log --no-color --date=iso --pretty=fuller --no-merges -n 1 "
                       cmd << " #{shell_quote rev} " if rev
                       cmd <<  "-- #{shell_quote path} " unless path.empty?
                       lines = []
                     def revisions(path, identifier_from, identifier_to, options={})
                       revisions = Revisions.new
-                      cmd = "#{GIT_BIN} --git-dir #{target('')} log --no-color --raw --date=iso --pretty=fuller "
+                      cmd = "#{self.class.sq_bin} --git-dir #{target('')} log --no-color --raw --date=iso --pretty=fuller "
                       cmd << " --reverse " if options[:reverse]
                       cmd << " --all " if options[:all]
                       cmd << " -n #{options[:limit].to_i} " if options[:limit]
                       path ||= ''
                       if identifier_to
-                        cmd = "#{GIT_BIN} --git-dir #{target('')} diff --no-color #{shell_quote identifier_to} #{shell_quote identifier_from}"
+                        cmd = "#{self.class.sq_bin} --git-dir #{target('')} diff --no-color #{shell_quote identifier_to} #{shell_quote identifier_from}"
                       else
-                        cmd = "#{GIT_BIN} --git-dir #{target('')} show --no-color #{shell_quote identifier_from}"
+                        cmd = "#{self.class.sq_bin} --git-dir #{target('')} show --no-color #{shell_quote identifier_from}"
                       end
                       cmd << " -- #{shell_quote path}" unless path.empty?
                     def annotate(path, identifier=nil)
                       identifier = 'HEAD' if identifier.blank?
-                      cmd = "#{GIT_BIN} --git-dir #{target('')} blame -p #{shell_quote identifier} -- #{shell_quote path}"
+                      cmd = "#{self.class.sq_bin} --git-dir #{target('')} blame -p #{shell_quote identifier} -- #{shell_quote path}"
                       blame = Annotate.new
                       content = nil
                       shellout(cmd) { |io| io.binmode; content = io.read }
                       if identifier.nil?
                         identifier = 'HEAD'
                       end
-                      cmd = "#{GIT_BIN} --git-dir #{target('')} show --no-color #{shell_quote(identifier + ':' + path)}"
+                      cmd = "#{self.class.sq_bin} --git-dir #{target('')} show --no-color #{shell_quote(identifier + ':' + path)}"
                       cat = nil
                       shellout(cmd) do |io|
                         io.binmode

lib/redmine/scm/adapters/mercurial_adapter.rb +19 -7

                     TEMPLATE_EXTENSION = "tmpl"
                     class << self
+                      def client_command
+                        @@bin    ||= HG_BIN
+                      end
+                      def sq_bin
+                        @@sq_bin ||= shell_quote(HG_BIN)
+                      end
                       def client_version
                         @@client_version ||= (hgversion || [])
                       end
+                      def client_available
+                        !client_version.empty?
+                      end
                       def hgversion
                         # The hg version is expressed either as a
                         # release number (eg 0.9.5 or 1.0) or as a revision
                       end
                       def hgversion_from_command_line
-                        shellout("#{HG_BIN} --version") { |io| io.read }.to_s
+                        shellout("#{sq_bin} --version") { |io| io.read }.to_s
                       end
                       def template_path
                     end
                     def info
-                      cmd = "#{HG_BIN} -R #{target('')} root"
+                      cmd = "#{self.class.sq_bin} -R #{target('')} root"
                       root_url = nil
                       shellout(cmd) do |io|
                         root_url = io.read
                     def entries(path=nil, identifier=nil)
                       path ||= ''
                       entries = Entries.new
-                      cmd = "#{HG_BIN} -R #{target('')} --cwd #{target('')} locate"
+                      cmd = "#{self.class.sq_bin} -R #{target('')} --cwd #{target('')} locate"
                       cmd << " -r #{hgrev(identifier)}"
                       cmd << " " + shell_quote("path:#{path}") unless path.empty?
                       shellout(cmd) do |io|
                     # makes Mercurial produce a xml output.
                     def revisions(path=nil, identifier_from=nil, identifier_to=nil, options={})
                       revisions = Revisions.new
-                      cmd = "#{HG_BIN} --debug --encoding utf8 -R #{target('')} log -C --style #{shell_quote self.class.template_path}"
+                      cmd = "#{self.class.sq_bin} --debug --encoding utf8 -R #{target('')} log -C --style #{shell_quote self.class.template_path}"
                       if identifier_from && identifier_to
                         cmd << " -r #{hgrev(identifier_from)}:#{hgrev(identifier_to)}"
                       elsif identifier_from
                           return []
                         end
                       end
-                      cmd = "#{HG_BIN} -R #{target('')} --config diff.git=false diff --nodates #{diff_args}"
+                      cmd = "#{self.class.sq_bin} -R #{target('')} --config diff.git=false diff --nodates #{diff_args}"
                       cmd << " -I #{target(path)}" unless path.empty?
                       shellout(cmd) do |io|
                         io.each_line do |line|
                     end
                     def cat(path, identifier=nil)
-                      cmd = "#{HG_BIN} -R #{target('')} cat"
+                      cmd = "#{self.class.sq_bin} -R #{target('')} cat"
                       cmd << " -r #{hgrev(identifier)}"
                       cmd << " #{target(path)}"
                       cat = nil
                     def annotate(path, identifier=nil)
                       path ||= ''
-                      cmd = "#{HG_BIN} -R #{target('')}"
+                      cmd = "#{self.class.sq_bin} -R #{target('')}"
                       cmd << " annotate -ncu"
                       cmd << " -r #{hgrev(identifier)}"
                       cmd << " #{target(path)}"

lib/redmine/scm/adapters/subversion_adapter.rb +16 -8

                     SVN_BIN = Redmine::Configuration['scm_subversion_command'] || "svn"
                     class << self
+                      def client_command
+                        @@bin    ||= SVN_BIN
+                      end
+                      def sq_bin
+                        @@sq_bin ||= shell_quote(SVN_BIN)
+                      end
                       def client_version
                         @@client_version ||= (svn_binary_version || [])
                       end
                       def svn_binary_version
-                        cmd = "#{SVN_BIN} --version"
+                        cmd = "#{sq_bin} --version"
                         version = nil
                         shellout(cmd) do |io|
                           # Read svn version in first returned line
                     # Get info about the svn repository
                     def info
-                      cmd = "#{SVN_BIN} info --xml #{target}"
+                      cmd = "#{self.class.sq_bin} info --xml #{target}"
                       cmd << credentials_string
                       info = nil
                       shellout(cmd) do |io|
                       path ||= ''
                       identifier = (identifier and identifier.to_i > 0) ? identifier.to_i : "HEAD"
                       entries = Entries.new
-                      cmd = "#{SVN_BIN} list --xml #{target(path)}@#{identifier}"
+                      cmd = "#{self.class.sq_bin} list --xml #{target(path)}@#{identifier}"
                       cmd << credentials_string
                       shellout(cmd) do |io|
                         output = io.read
                       return nil unless self.class.client_version_above?([1, 5, 0])
                       identifier = (identifier and identifier.to_i > 0) ? identifier.to_i : "HEAD"
-                      cmd = "#{SVN_BIN} proplist --verbose --xml #{target(path)}@#{identifier}"
+                      cmd = "#{self.class.sq_bin} proplist --verbose --xml #{target(path)}@#{identifier}"
                       cmd << credentials_string
                       properties = {}
                       shellout(cmd) do |io|
                       identifier_from = (identifier_from && identifier_from.to_i > 0) ? identifier_from.to_i : "HEAD"
                       identifier_to = (identifier_to && identifier_to.to_i > 0) ? identifier_to.to_i : 1
                       revisions = Revisions.new
-                      cmd = "#{SVN_BIN} log --xml -r #{identifier_from}:#{identifier_to}"
+                      cmd = "#{self.class.sq_bin} log --xml -r #{identifier_from}:#{identifier_to}"
                       cmd << credentials_string
                       cmd << " --verbose " if  options[:with_paths]
                       cmd << " --limit #{options[:limit].to_i}" if options[:limit]
                       identifier_from = (identifier_from and identifier_from.to_i > 0) ? identifier_from.to_i : ''
                       identifier_to = (identifier_to and identifier_to.to_i > 0) ? identifier_to.to_i : (identifier_from.to_i - 1)
-                      cmd = "#{SVN_BIN} diff -r "
+                      cmd = "#{self.class.sq_bin} diff -r "
                       cmd << "#{identifier_to}:"
                       cmd << "#{identifier_from}"
                       cmd << " #{target(path)}@#{identifier_from}"
                     def cat(path, identifier=nil)
                       identifier = (identifier and identifier.to_i > 0) ? identifier.to_i : "HEAD"
-                      cmd = "#{SVN_BIN} cat #{target(path)}@#{identifier}"
+                      cmd = "#{self.class.sq_bin} cat #{target(path)}@#{identifier}"
                       cmd << credentials_string
                       cat = nil
                       shellout(cmd) do |io|
                     def annotate(path, identifier=nil)
                       identifier = (identifier and identifier.to_i > 0) ? identifier.to_i : "HEAD"
-                      cmd = "#{SVN_BIN} blame #{target(path)}@#{identifier}"
+                      cmd = "#{self.class.sq_bin} blame #{target(path)}@#{identifier}"
                       cmd << credentials_string
                       blame = Annotate.new
                       shellout(cmd) do |io|

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