cvs2svn_lib/cvs_revision_manager.py

   1 # (Be in -*- python -*- mode.)
   2 #
   3 # ====================================================================
   4 # Copyright (c) 2000-2008 CollabNet.  All rights reserved.
   5 #
   6 # This software is licensed as described in the file COPYING, which
   7 # you should have received as part of this distribution.  The terms
   8 # are also available at http://subversion.tigris.org/license-1.html.
   9 # If newer versions of this license are posted there, you may use a
  10 # newer version instead, at your option.
  11 #
  12 # This software consists of voluntary contributions made by many
  13 # individuals.  For exact contribution history, see the revision
  14 # history and logs, available at http://cvs2svn.tigris.org/.
  15 # ====================================================================
  16
  17 """Access the CVS repository via CVS's 'cvs' command."""
  18
  19
  20 from cvs2svn_lib.common import FatalError
  21 from cvs2svn_lib.common import canonicalize_eol
  22 from cvs2svn_lib.process import check_command_runs
  23 from cvs2svn_lib.process import get_command_output
  24 from cvs2svn_lib.process import CommandFailedException
  25 from cvs2svn_lib.context import Ctx
  26 from cvs2svn_lib.revision_manager import RevisionReader
  27 from cvs2svn_lib.abstract_rcs_revision_manager import AbstractRCSRevisionReader
  28 from cvs2svn_lib.apple_single_filter import get_maybe_apple_single
  29
  30
  31 class CVSRevisionReader(AbstractRCSRevisionReader):
  32   """A RevisionReader that reads the contents via CVS."""
  33
  34   # Different versions of CVS support different global options.  Here
  35   # are the global options that we try to use, in order of decreasing
  36   # preference:
  37   _possible_global_options = [
  38       ['-Q', '-R', '-f'],
  39       ['-Q', '-R'],
  40       ['-Q', '-f'],
  41       ['-Q'],
  42       ['-q', '-R', '-f'],
  43       ['-q', '-R'],
  44       ['-q', '-f'],
  45       ['-q'],
  46       ]
  47
  48   def __init__(self, cvs_executable, global_options=None):
  49     """Initialize a CVSRevisionReader.
  50
  51     CVS_EXECUTABLE is the CVS command (possibly including the full
  52     path to the executable; otherwise it is sought in the $PATH).
  53     GLOBAL_ARGUMENTS, if specified, should be a list of global options
  54     that are passed to the CVS command before the subcommand.  If
  55     GLOBAL_ARGUMENTS is not specified, then each of the possibilities
  56     listed in _possible_global_options is checked in order until one
  57     is found that runs successfully and without any output to stderr."""
  58
  59     self.cvs_executable = cvs_executable
  60
  61     if global_options is None:
  62       for global_options in self._possible_global_options:
  63         try:
  64           self._check_cvs_runs(global_options)
  65         except CommandFailedException, e:
  66           pass
  67         else:
  68           break
  69       else:
  70         raise FatalError(
  71             '%s\n'
  72             'Please check that cvs is installed and in your PATH.' % (e,)
  73             )
  74     else:
  75       try:
  76         self._check_cvs_runs(global_options)
  77       except CommandFailedException, e:
  78         raise FatalError(
  79             '%s\n'
  80             'Please check that cvs is installed and in your PATH and that\n'
  81             'the global options that you specified (%r) are correct.'
  82             % (e, global_options,)
  83             )
  84
  85     # The global options were OK; use them for all CVS invocations.
  86     self.global_options = global_options
  87
  88   def _check_cvs_runs(self, global_options):
  89     """Check that CVS can be started.
  90
  91     Try running 'cvs --version' with the current setting for
  92     self.cvs_executable and the specified global_options.  If not
  93     successful, raise a CommandFailedException."""
  94
  95     check_command_runs(
  96         [self.cvs_executable] + global_options + ['--version'],
  97         self.cvs_executable,
  98         )
  99
 100   def get_content(self, cvs_rev):
 101     project = cvs_rev.cvs_file.project
 102     pipe_cmd = [
 103         self.cvs_executable
 104         ] + self.global_options + [
 105         '-d', ':local:' + project.cvs_repository_root,
 106         'co',
 107         '-r' + cvs_rev.rev,
 108         '-p'
 109         ] + self.select_k_option(cvs_rev) + [
 110         project.cvs_module + cvs_rev.cvs_path
 111         ]
 112     data = get_command_output(pipe_cmd)
 113
 114     if Ctx().decode_apple_single:
 115       # Insert a filter to decode any files that are in AppleSingle
 116       # format:
 117       data = get_maybe_apple_single(data)
 118
 119     eol_fix = cvs_rev.get_property('_eol_fix')
 120     if eol_fix:
 121       data = canonicalize_eol(data, eol_fix)
 122
 123     return data
 124
 125