Class: Redmine::Scm::Adapters::SubversionAdapter

Inherits:
AbstractAdapter show all
Defined in:
lib/redmine/scm/adapters/subversion_adapter.rb

Constant Summary

SVN_BIN =

SVN executable name

"svn"

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractAdapter

#adapter_name, client_version_above?, client_version_string, #entry, #initialize, #root_url, #shell_quote, #supports_annotate?, #supports_cat?, #url, #with_leading_slash, #with_trailling_slash, #without_leading_slash, #without_trailling_slash

Constructor Details

This class inherits a constructor from Redmine::Scm::Adapters::AbstractAdapter

Class Method Details

.client_versionObject



31
32
33
# File 'lib/redmine/scm/adapters/subversion_adapter.rb', line 31

def client_version
  @@client_version ||= (svn_binary_version || [])
end

.svn_binary_versionObject



35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/redmine/scm/adapters/subversion_adapter.rb', line 35

def svn_binary_version
  cmd = "#{SVN_BIN} --version"
  version = nil
  shellout(cmd) do |io|
    # Read svn version in first returned line
    if m = io.gets.match(%r{((\d+\.)+\d+)})
      version = m[0].scan(%r{\d+}).collect(&:to_i)
    end
  end
  return nil if $? && $?.exitstatus != 0
  version
end

Instance Method Details

#annotate(path, identifier = nil) ⇒ Object



207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/redmine/scm/adapters/subversion_adapter.rb', line 207

def annotate(path, identifier=nil)
  identifier = (identifier and identifier.to_i > 0) ? identifier.to_i : "HEAD"
  cmd = "#{SVN_BIN} blame #{target(URI.escape(path))}@#{identifier}"
  cmd << credentials_string
  blame = Annotate.new
  shellout(cmd) do |io|
    io.each_line do |line|
      next unless line =~ %r{^\s*(\d+)\s*(\S+)\s(.*)$}
      blame.add_line($3.rstrip, Revision.new(:identifier => $1.to_i, :author => $2.strip))
    end
  end
  return nil if $? && $?.exitstatus != 0
  blame
end

#cat(path, identifier = nil) ⇒ Object



194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/redmine/scm/adapters/subversion_adapter.rb', line 194

def cat(path, identifier=nil)
  identifier = (identifier and identifier.to_i > 0) ? identifier.to_i : "HEAD"
  cmd = "#{SVN_BIN} cat #{target(URI.escape(path))}@#{identifier}"
  cmd << credentials_string
  cat = nil
  shellout(cmd) do |io|
    io.binmode
    cat = io.read
  end
  return nil if $? && $?.exitstatus != 0
  cat
end

#diff(path, identifier_from, identifier_to = nil, type = "inline") ⇒ Object



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/redmine/scm/adapters/subversion_adapter.rb', line 174

def diff(path, identifier_from, identifier_to=nil, type="inline")
  path ||= ''
  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 << "#{identifier_to}:"
  cmd << "#{identifier_from}"
  cmd << " #{target(URI.escape(path))}@#{identifier_from}"
  cmd << credentials_string
  diff = []
  shellout(cmd) do |io|
    io.each_line do |line|
      diff << line
    end
  end
  return nil if $? && $?.exitstatus != 0
  diff
end

#entries(path = nil, identifier = nil) ⇒ Object

Returns an Entries collection or nil if the given path doesn't exist in the repository



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/redmine/scm/adapters/subversion_adapter.rb', line 76

def entries(path=nil, identifier=nil)
  path ||= ''
  identifier = (identifier and identifier.to_i > 0) ? identifier.to_i : "HEAD"
  entries = Entries.new
  cmd = "#{SVN_BIN} list --xml #{target(URI.escape(path))}@#{identifier}"
  cmd << credentials_string
  shellout(cmd) do |io|
    output = io.read
    begin
      doc = REXML::Document.new(output)
      doc.elements.each("lists/list/entry") do |entry|
        commit = entry.elements['commit']
        commit_date = commit.elements['date']
        # Skip directory if there is no commit date (usually that
        # means that we don't have read access to it)
        next if entry.attributes['kind'] == 'dir' && commit_date.nil?
        name = entry.elements['name'].text
        entries << Entry.new({:name => URI.unescape(name),
                    :path => ((path.empty? ? "" : "#{path}/") + name),
                    :kind => entry.attributes['kind'],
                    :size => ((s = entry.elements['size']) ? s.text.to_i : nil),
                    :lastrev => Revision.new({
                      :identifier => commit.attributes['revision'],
                      :time => Time.parse(commit_date.text).localtime,
                      :author => ((a = commit.elements['author']) ? a.text : nil)
                      })
                    })
      end
    rescue Exception => e
      logger.error("Error parsing svn output: #{e.message}")
      logger.error("Output was:\n #{output}")
    end
  end
  return nil if $? && $?.exitstatus != 0
  logger.debug("Found #{entries.size} entries in the repository for #{target(path)}") if logger && logger.debug?
  entries.sort_by_name
end

#infoObject

Get info about the svn repository



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/redmine/scm/adapters/subversion_adapter.rb', line 50

def info
  cmd = "#{SVN_BIN} info --xml #{target('')}"
  cmd << credentials_string
  info = nil
  shellout(cmd) do |io|
    begin
      doc = REXML::Document.new(io)
      #root_url = doc.elements["info/entry/repository/root"].text          
      info = Info.new({:root_url => doc.elements["info/entry/repository/root"].text,
                       :lastrev => Revision.new({
                         :identifier => doc.elements["info/entry/commit"].attributes['revision'],
                         :time => Time.parse(doc.elements["info/entry/commit/date"].text).localtime,
                         :author => (doc.elements["info/entry/commit/author"] ? doc.elements["info/entry/commit/author"].text : "")
                       })
                     })
    rescue
    end
  end
  return nil if $? && $?.exitstatus != 0
  info
rescue CommandFailed
  return nil
end

#properties(path, identifier = nil) ⇒ Object



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'lib/redmine/scm/adapters/subversion_adapter.rb', line 114

def properties(path, identifier=nil)
  # proplist xml output supported in svn 1.5.0 and higher
  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(URI.escape(path))}@#{identifier}"
  cmd << credentials_string
  properties = {}
  shellout(cmd) do |io|
    output = io.read
    begin
      doc = REXML::Document.new(output)
      doc.elements.each("properties/target/property") do |property|
        properties[ property.attributes['name'] ] = property.text
      end
    rescue
    end
  end
  return nil if $? && $?.exitstatus != 0
  properties
end

#revisions(path = nil, identifier_from = nil, identifier_to = nil, options = {}) ⇒ Object



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/redmine/scm/adapters/subversion_adapter.rb', line 136

def revisions(path=nil, identifier_from=nil, identifier_to=nil, options={})
  path ||= ''
  identifier_from = (identifier_from and identifier_from.to_i > 0) ? identifier_from.to_i : "HEAD"
  identifier_to = (identifier_to and identifier_to.to_i > 0) ? identifier_to.to_i : 1
  revisions = Revisions.new
  cmd = "#{SVN_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]
  cmd << ' ' + target(URI.escape(path))
  shellout(cmd) do |io|
    begin
      doc = REXML::Document.new(io)
      doc.elements.each("log/logentry") do |logentry|
        paths = []
        logentry.elements.each("paths/path") do |path|
          paths << {:action => path.attributes['action'],
                    :path => path.text,
                    :from_path => path.attributes['copyfrom-path'],
                    :from_revision => path.attributes['copyfrom-rev']
                    }
        end
        paths.sort! { |x,y| x[:path] <=> y[:path] }
        
        revisions << Revision.new({:identifier => logentry.attributes['revision'],
                      :author => (logentry.elements['author'] ? logentry.elements['author'].text : ""),
                      :time => Time.parse(logentry.elements['date'].text).localtime,
                      :message => logentry.elements['msg'].text,
                      :paths => paths
                    })
      end
    rescue
    end
  end
  return nil if $? && $?.exitstatus != 0
  revisions
end