Class: Redmine::Scm::Adapters::CvsAdapter

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

Defined Under Namespace

Classes: Revision

Constant Summary

CVS_BIN =

CVS executable name

Redmine::Configuration['scm_cvs_command'] || "cvs"
STARTLOG = 
"----------------------------"
ENDLOG = 
"============================================================================="

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractAdapter

#adapter_name, #branches, client_version_above?, client_version_string, #default_branch, #entry, #properties, #root_url, shell_quote, #shell_quote, shell_quote_command, #supports_annotate?, #supports_cat?, #tags, #url, #with_leading_slash, #with_trailling_slash, #without_leading_slash, #without_trailling_slash

Constructor Details

#initialize(url, root_url = nil, login = nil, password = nil, path_encoding = nil) ⇒ CvsAdapter

Guidelines for the input:

url      -> the project-path, relative to the cvsroot (eg. module name)
root_url -> the good old, sometimes damned, CVSROOT
login    -> unnecessary
password -> unnecessary too

Raises:



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 62

def initialize(url, root_url=nil, =nil, password=nil,
               path_encoding=nil)
  @path_encoding = path_encoding.blank? ? 'UTF-8' : path_encoding
  @url      = url
  # TODO: better Exception here (IllegalArgumentException)
  raise CommandFailed if root_url.blank?
  @root_url  = root_url

  # These are unused.
  @login    =  if  && !.empty?
  @password = (password || "") if @login
end

Class Method Details

.client_available ⇒ Object 



41
42
43
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 41

def client_available
  client_version_above?([1, 12])
end

.client_command ⇒ Object 



29
30
31
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 29

def client_command
  @@bin    ||= CVS_BIN
end

.client_version ⇒ Object 



37
38
39
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 37

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

.scm_command_version ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 45

def scm_command_version
  scm_version = scm_version_from_command_line.dup.force_encoding('ASCII-8BIT')
  if m = scm_version.match(%r{\A(.*?)((\d+\.)+\d+)}m)
    m[2].scan(%r{\d+}).collect(&:to_i)
  end
end

.scm_version_from_command_line ⇒ Object 



52
53
54
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 52

def scm_version_from_command_line
  shellout("#{sq_bin} --version") { |io| io.read }.to_s
end

.sq_bin ⇒ Object 



33
34
35
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 33

def sq_bin
  @@sq_bin ||= shell_quote_command
end

Instance Method Details

#annotate(path, identifier = nil) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 305

def annotate(path, identifier=nil)
  identifier = (identifier) ? identifier : "HEAD"
  logger.debug "<cvs> annotate path:'#{path}',identifier #{identifier}"
  cmd_args = %w|rannotate|
  cmd_args << "-D" << time_to_cvstime(identifier) if identifier
  cmd_args << path_with_proj(path)
  blame = Annotate.new
  scm_cmd(*cmd_args) do |io|
    io.each_line do |line|
      next unless line =~ %r{^([\d\.]+)\s+\(([^\)]+)\s+[^\)]+\):\s(.*)$}
      blame.add_line(
          $3.rstrip,
          Revision.new(
            :revision   => $1,
            :identifier => nil,
            :author     => $2.strip
            ))
    end
  end
  blame
rescue ScmCommandAborted
  Annotate.new
end

#cat(path, identifier = nil) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 289

def cat(path, identifier=nil)
  identifier = (identifier) ? identifier : "HEAD"
  logger.debug "<cvs> cat path:'#{path}',identifier #{identifier}"
  cmd_args = %w|-q co|
  cmd_args << "-D" << time_to_cvstime(identifier) if identifier
  cmd_args << "-p" << path_with_proj(path)
  cat = nil
  scm_cmd(*cmd_args) do |io|
    io.binmode
    cat = io.read
  end
  cat
rescue ScmCommandAborted
  nil
end

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 271

def diff(path, identifier_from, identifier_to=nil)
  logger.debug "<cvs> diff path:'#{path}'" +
      ",identifier_from #{identifier_from}, identifier_to #{identifier_to}"
  cmd_args = %w|rdiff -u|
  cmd_args << "-r#{identifier_to}"
  cmd_args << "-r#{identifier_from}"
  cmd_args << path_with_proj(path)
  diff = []
  scm_cmd(*cmd_args) do |io|
    io.each_line do |line|
      diff << line
    end
  end
  diff
rescue ScmCommandAborted
  nil
end

#entries(path = nil, identifier = nil, options = {}) ⇒ Object

Returns an Entries collection or nil if the given path doesn't exist in the repository this method is used by the repository-browser (aka LIST)



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 91

def entries(path=nil, identifier=nil, options={})
  logger.debug "<cvs> entries '#{path}' with identifier '#{identifier}'"
  path_locale = scm_iconv(@path_encoding, 'UTF-8', path)
  path_locale.force_encoding("ASCII-8BIT")
  entries = Entries.new
  cmd_args = %w|-q rls -e|
  cmd_args << "-D" << time_to_cvstime_rlog(identifier) if identifier
  cmd_args << path_with_proj(path)
  scm_cmd(*cmd_args) do |io|
    io.each_line() do |line|
      fields = line.chop.split('/',-1)
      logger.debug(">>InspectLine #{fields.inspect}")
      if fields[0]!="D"
        time = nil
        # Thu Dec 13 16:27:22 2007
        time_l = fields[-3].split(' ')
        if time_l.size == 5 && time_l[4].length == 4
          begin
            time = Time.parse(
                     "#{time_l[1]} #{time_l[2]} #{time_l[3]} GMT #{time_l[4]}")
          rescue
          end
        end
        entries << Entry.new(
         {
          :name => scm_iconv('UTF-8', @path_encoding, fields[-5]),
          #:path => fields[-4].include?(path)?fields[-4]:(path + "/"+ fields[-4]),
          :path => scm_iconv('UTF-8', @path_encoding, "#{path_locale}/#{fields[-5]}"),
          :kind => 'file',
          :size => nil,
          :lastrev => Revision.new(
              {
                :revision => fields[-4],
                :name     => scm_iconv('UTF-8', @path_encoding, fields[-4]),
                :time     => time,
                :author   => ''
              })
          })
      else
        entries << Entry.new(
         {
          :name    => scm_iconv('UTF-8', @path_encoding, fields[1]),
          :path    => scm_iconv('UTF-8', @path_encoding, "#{path_locale}/#{fields[1]}"),
          :kind    => 'dir',
          :size    => nil,
          :lastrev => nil
         })
      end
    end
  end
  entries.sort_by_name
rescue ScmCommandAborted
  nil
end

#get_previous_revision(revision) ⇒ Object 



84
85
86
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 84

def get_previous_revision(revision)
  CvsRevisionHelper.new(revision).prevRev
end

#info ⇒ Object 



79
80
81
82
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 79

def info
  logger.debug "<cvs> info"
  Info.new({:root_url => @root_url, :lastrev => nil})
end

#path_encoding ⇒ Object 



75
76
77
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 75

def path_encoding
  @path_encoding
end

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

Returns all revisions found between identifier_from and identifier_to in the repository. both identifier have to be dates or nil. these method returns nothing but yield every result in block



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/redmine/scm/adapters/cvs_adapter.rb', line 152

def revisions(path=nil, identifier_from=nil, identifier_to=nil, options={}, &block)
  path_with_project_utf8   = path_with_proj(path)
  path_with_project_locale = scm_iconv(@path_encoding, 'UTF-8', path_with_project_utf8)
  logger.debug "<cvs> revisions path:" +
      "'#{path}',identifier_from #{identifier_from}, identifier_to #{identifier_to}"
  cmd_args = %w|-q rlog|
  cmd_args << "-d" << ">#{time_to_cvstime_rlog(identifier_from)}" if identifier_from
  cmd_args << path_with_project_utf8
  scm_cmd(*cmd_args) do |io|
    state      = "entry_start"
    commit_log = String.new
    revision   = nil
    date       = nil
    author     = nil
    entry_path = nil
    entry_name = nil
    file_state = nil
    branch_map = nil
    io.each_line() do |line|
      if state != "revision" && /^#{ENDLOG}/ =~ line
        commit_log = String.new
        revision   = nil
        state      = "entry_start"
      end
      if state == "entry_start"
        branch_map = Hash.new
        if /^RCS file: #{Regexp.escape(root_url_path)}\/#{Regexp.escape(path_with_project_locale)}(.+),v$/ =~ line
          entry_path = normalize_cvs_path($1)
          entry_name = normalize_path(File.basename($1))
          logger.debug("Path #{entry_path} <=> Name #{entry_name}")
        elsif /^head: (.+)$/ =~ line
          entry_headRev = $1 #unless entry.nil?
        elsif /^symbolic names:/ =~ line
          state = "symbolic" #unless entry.nil?
        elsif /^#{STARTLOG}/ =~ line
          commit_log = String.new
          state      = "revision"
        end
        next
      elsif state == "symbolic"
        if /^(.*):\s(.*)/ =~ (line.strip)
          branch_map[$1] = $2
        else
          state = "tags"
          next
        end
      elsif state == "tags"
        if /^#{STARTLOG}/ =~ line
          commit_log = ""
          state = "revision"
        elsif /^#{ENDLOG}/ =~ line
          state = "head"
        end
        next
      elsif state == "revision"
        if /^#{ENDLOG}/ =~ line || /^#{STARTLOG}/ =~ line
          if revision
            revHelper = CvsRevisionHelper.new(revision)
            revBranch = "HEAD"
            branch_map.each() do |branch_name, branch_point|
              if revHelper.is_in_branch_with_symbol(branch_point)
                revBranch = branch_name
              end
            end
            logger.debug("********** YIELD Revision #{revision}::#{revBranch}")
            yield Revision.new({
              :time    => date,
              :author  => author,
              :message => commit_log.chomp,
              :paths => [{
                :revision => revision.dup,
                :branch   => revBranch.dup,
                :path     => scm_iconv('UTF-8', @path_encoding, entry_path),
                :name     => scm_iconv('UTF-8', @path_encoding, entry_name),
                :kind     => 'file',
                :action   => file_state
                   }]
                 })
          end
          commit_log = String.new
          revision   = nil
          if /^#{ENDLOG}/ =~ line
            state = "entry_start"
          end
          next
        end

        if /^branches: (.+)$/ =~ line
          # TODO: version.branch = $1
        elsif /^revision (\d+(?:\.\d+)+).*$/ =~ line
          revision = $1
        elsif /^date:\s+(\d+.\d+.\d+\s+\d+:\d+:\d+)/ =~ line
          date       = Time.parse($1)
          line_utf8    = scm_iconv('UTF-8', options[:log_encoding], line)
          author_utf8  = /author: ([^;]+)/.match(line_utf8)[1]
          author       = scm_iconv(options[:log_encoding], 'UTF-8', author_utf8)
          file_state   = /state: ([^;]+)/.match(line)[1]
          # TODO:
          #    linechanges only available in CVS....
          #    maybe a feature our SVN implementation.
          #    I'm sure, they are useful for stats or something else
          #                linechanges =/lines: \+(\d+) -(\d+)/.match(line)
          #                unless linechanges.nil?
          #                  version.line_plus  = linechanges[1]
          #                  version.line_minus = linechanges[2]
          #                else
          #                  version.line_plus  = 0
          #                  version.line_minus = 0
          #                end
        else
          commit_log << line unless line =~ /^\*\*\* empty log message \*\*\*/
        end
      end
    end
  end
rescue ScmCommandAborted
  Revisions.new
end