cvs2svn_lib/context.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 """Store the context (options, etc) for a cvs2svn run."""
  18
  19
  20 import os
  21 import textwrap
  22
  23 from cvs2svn_lib import config
  24 from cvs2svn_lib.common import CVSTextDecoder
  25
  26
  27 class Ctx:
  28   """Session state for this run of cvs2svn.  For example, run-time
  29   options are stored here.  This class is a Borg (see
  30   http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66531)."""
  31
  32   __shared_state = { }
  33
  34   def __init__(self):
  35     self.__dict__ = self.__shared_state
  36     if self.__dict__:
  37       return
  38     # Else, initialize to defaults.
  39     self.set_defaults()
  40
  41   def set_defaults(self):
  42     """Set all parameters to their default values."""
  43
  44     self.output_option = None
  45     self.dry_run = False
  46     self.revision_collector = None
  47     self.revision_reader = None
  48     self.svnadmin_executable = config.SVNADMIN_EXECUTABLE
  49     self.trunk_only = False
  50     self.include_empty_directories = False
  51     self.prune = True
  52     self.cvs_author_decoder = CVSTextDecoder(['ascii'])
  53     self.cvs_log_decoder = CVSTextDecoder(['ascii'], eol_fix='\n')
  54     self.cvs_filename_decoder = CVSTextDecoder(['ascii'])
  55     self.decode_apple_single = False
  56     self.symbol_info_filename = None
  57     self.username = None
  58     self.file_property_setters = []
  59     self.revision_property_setters = []
  60     self.tmpdir = 'cvs2svn-tmp'
  61     self.skip_cleanup = False
  62     self.keep_cvsignore = False
  63     self.cross_project_commits = True
  64     self.cross_branch_commits = True
  65     self.retain_conflicting_attic_files = False
  66
  67     # textwrap.TextWrapper instance to be used for wrapping log messages:
  68     self.text_wrapper = textwrap.TextWrapper(width=76, break_long_words=False)
  69
  70     self.initial_project_commit_message = (
  71         'Standard project directories initialized by cvs2svn.'
  72         )
  73     self.post_commit_message = (
  74         'This commit was generated by cvs2svn to compensate for '
  75         'changes in r%(revnum)d, which included commits to RCS files '
  76         'with non-trunk default branches.'
  77         )
  78     self.symbol_commit_message = (
  79         "This commit was manufactured by cvs2svn to create %(symbol_type)s "
  80         "'%(symbol_name)s'."
  81         )
  82     self.tie_tag_ancestry_message = (
  83         "This commit was manufactured by cvs2svn to tie ancestry for "
  84         "tag '%(symbol_name)s' back to the source branch."
  85         )
  86
  87
  88   def get_temp_filename(self, basename):
  89     return os.path.join(self.tmpdir, basename)
  90
  91   def clean(self):
  92     """Dispose of items in our dictionary that are not intended to
  93     live past the end of a pass (identified by exactly one leading
  94     underscore)."""
  95
  96     for attr in self.__dict__.keys():
  97       if (attr.startswith('_') and not attr.startswith('__')
  98           and not attr.startswith('_Ctx__')):
  99         delattr(self, attr)
 100
 101