cvs2svn_lib/fulltext_revision_recorder.py

   1 # (Be in -*- python -*- mode.)
   2 #
   3 # ====================================================================
   4 # Copyright (c) 2007-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 """An abstract class that contructs file contents during CollectRevsPass.
  18
  19 It calls its record_fulltext() method with the full text of every
  20 revision.  This method should be overridden to do something with the
  21 fulltext and possibly return a revision_recorder_token."""
  22
  23
  24 from cvs2svn_lib.revision_manager import RevisionRecorder
  25
  26
  27 class FulltextRevisionRecorder:
  28   """Similar to a RevisionRecorder, but it requires the fulltext."""
  29
  30   def register_artifacts(self, which_pass):
  31     pass
  32
  33   def start(self):
  34     pass
  35
  36   def start_file(self, cvs_file_items):
  37     pass
  38
  39   def record_fulltext(self, cvs_rev, log, fulltext):
  40     """Record the fulltext for CVS_REV.
  41
  42     CVS_REV has the log message LOG and the fulltext FULLTEXT.  This
  43     method should be overridden to do something sensible with them."""
  44
  45     raise NotImplementedError()
  46
  47   def finish_file(self, cvs_file_items):
  48     pass
  49
  50   def finish(self):
  51     pass
  52
  53
  54 class FulltextRevisionRecorderAdapter(RevisionRecorder):
  55   """Reconstruct the fulltext and pass it to a FulltextRevisionRecorder.
  56
  57   This class implements RevisionRecorder (so it can be passed directly
  58   to CollectRevsPass).  But it doesn't actually record anything.
  59   Instead, it reconstructs the fulltext of each revision, and passes
  60   the fulltext to a fulltext_revision_recorder."""
  61
  62   def __init__(self, fulltext_revision_recorder):
  63     RevisionRecorder.__init__(self)
  64     self.fulltext_revision_recorder = fulltext_revision_recorder
  65
  66   def register_artifacts(self, which_pass):
  67     self.fulltext_revision_recorder.register_artifacts(which_pass)
  68
  69   def start(self):
  70     self.fulltext_revision_recorder.start()
  71
  72   def start_file(self, cvs_file_items):
  73     self.fulltext_revision_recorder.start_file(cvs_file_items)
  74
  75   def record_text(self, cvs_rev, log, text):
  76     """This method should be overwridden.
  77
  78     It should determine the fulltext of CVS_REV, then pass it to
  79     self.fulltext_revision_recorder.record_fulltext() and return the
  80     result."""
  81
  82     raise NotImplementedError()
  83
  84   def finish_file(self, cvs_file_items):
  85     self.fulltext_revision_recorder.finish_file(cvs_file_items)
  86
  87   def finish(self):
  88     self.fulltext_revision_recorder.finish()
  89
  90
  91 class SimpleFulltextRevisionRecorderAdapter(FulltextRevisionRecorderAdapter):
  92   """Reconstruct the fulltext using a RevisionReader.
  93
  94   To create the fulltext, this class simply uses a RevisionReader (for
  95   example, RCSRevisionReader or CVSRevisionReader).  This is not quite
  96   as wasteful as using one of these RevisionReaders in OutputPass,
  97   because the same RCS file will be read over and over (and so
  98   presumably stay in the disk cache).  But it is still pretty silly,
  99   considering that we have all the RCS deltas available to us."""
 100
 101   def __init__(self, revision_reader, fulltext_revision_recorder):
 102     FulltextRevisionRecorderAdapter.__init__(self, fulltext_revision_recorder)
 103     self.revision_reader = revision_reader
 104
 105   def register_artifacts(self, which_pass):
 106     FulltextRevisionRecorderAdapter.register_artifacts(self, which_pass)
 107     self.revision_reader.register_artifacts(which_pass)
 108
 109   def start(self):
 110     FulltextRevisionRecorderAdapter.start(self)
 111     self.revision_reader.start()
 112
 113   def record_text(self, cvs_rev, log, text):
 114     # FIXME: We have to decide what to do about keyword substitution
 115     # and eol_style here:
 116     fulltext = self.revision_reader.get_content_stream(
 117         cvs_rev, suppress_keyword_substitution=False
 118         ).read()
 119     return self.fulltext_revision_recorder.record_fulltext(
 120         cvs_rev, log, fulltext
 121         )
 122
 123   def finish(self):
 124     FulltextRevisionRecorderAdapter.finish(self)
 125     self.revision_reader.finish()
 126
 127