cvs2svn_lib/output_option.py

   1 # (Be in -*- python -*- mode.)
   2 #
   3 # ====================================================================
   4 # Copyright (c) 2000-2009 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 """This module contains classes that hold the cvs2svn output options."""
  18
  19 from cvs2svn_lib.common import IllegalSVNPathError
  20
  21
  22 class OutputOption:
  23   """Represents an output choice for a run of cvs2svn."""
  24
  25   # name of output format (for error messages), capitalized for use at
  26   # the start of a sentence.  This class attribute must be set by
  27   # subclasses
  28   name = None
  29
  30   def register_artifacts(self, which_pass):
  31     """Register artifacts that will be needed for this output option.
  32
  33     WHICH_PASS is the pass that will call our callbacks, so it should
  34     be used to do the registering (e.g., call
  35     WHICH_PASS.register_temp_file() and/or
  36     WHICH_PASS.register_temp_file_needed())."""
  37
  38     pass
  39
  40   def verify_filename_legal(self, filename):
  41     """Verify that FILENAME is a legal filename.
  42
  43     FILENAME is a path component of a CVS path.  Check that it won't
  44     choke the destination VCS:
  45
  46     - Check that it is not empty.
  47
  48     - Check that it is not equal to '.' or '..'.
  49
  50     - Check that the filename does not include any characters that are
  51       illegal in the destination VCS.
  52
  53     If any of these tests fail, raise an IllegalSVNPathError.
  54
  55     This method should be overridden as needed by derived classes."""
  56
  57     if filename == '':
  58       raise IllegalSVNPathError("Empty filename component.")
  59
  60     if filename in ['.', '..']:
  61       raise IllegalSVNPathError("Illegal filename component %r." % (filename,))
  62
  63   def check(self):
  64     """Check that the options stored in SELF are sensible.
  65
  66     This might including the existence of a repository on disk, etc."""
  67
  68     raise NotImplementedError()
  69
  70   def check_symbols(self, symbol_map):
  71     """Check that the symbols in SYMBOL_MAP are OK for this output option.
  72
  73     SYMBOL_MAP is a map {AbstractSymbol : (Trunk|TypedSymbol)},
  74     indicating how each symbol is planned to be converted.  Raise a
  75     FatalError if the symbol plan is not acceptable for this output
  76     option."""
  77
  78     raise NotImplementedError()
  79
  80   def setup(self, svn_rev_count):
  81     """Prepare this output option."""
  82
  83     raise NotImplementedError()
  84
  85   def process_initial_project_commit(self, svn_commit):
  86     """Process SVN_COMMIT, which is an SVNInitialProjectCommit."""
  87
  88     raise NotImplementedError()
  89
  90   def process_primary_commit(self, svn_commit):
  91     """Process SVN_COMMIT, which is an SVNPrimaryCommit."""
  92
  93     raise NotImplementedError()
  94
  95   def process_post_commit(self, svn_commit):
  96     """Process SVN_COMMIT, which is an SVNPostCommit."""
  97
  98     raise NotImplementedError()
  99
 100   def process_branch_commit(self, svn_commit):
 101     """Process SVN_COMMIT, which is an SVNBranchCommit."""
 102
 103     raise NotImplementedError()
 104
 105   def process_tag_commit(self, svn_commit):
 106     """Process SVN_COMMIT, which is an SVNTagCommit."""
 107
 108     raise NotImplementedError()
 109
 110   def cleanup(self):
 111     """Perform any required cleanup related to this output option."""
 112
 113     raise NotImplementedError()
 114
 115
 116 class NullOutputOption(OutputOption):
 117   """An OutputOption that doesn't do anything."""
 118
 119   name = 'null'
 120
 121   def check(self):
 122     pass
 123
 124   def check_symbols(self, symbol_map):
 125     pass
 126
 127   def setup(self, svn_rev_count):
 128     pass
 129
 130   def process_initial_project_commit(self, svn_commit):
 131     pass
 132
 133   def process_primary_commit(self, svn_commit):
 134     pass
 135
 136   def process_post_commit(self, svn_commit):
 137     pass
 138
 139   def process_branch_commit(self, svn_commit):
 140     pass
 141
 142   def process_tag_commit(self, svn_commit):
 143     pass
 144
 145   def cleanup(self):
 146     pass
 147
 148