cvs2svn_lib/common.py

   1 # (Be in -*- python -*- mode.)
   2 #
   3 # ====================================================================
   4 # Copyright (c) 2000-2006 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 common facilities used by cvs2svn."""
  18
  19
  20 import time
  21
  22 from boolean import *
  23
  24
  25 SVN_INVALID_REVNUM = -1
  26
  27
  28 # Things that can happen to a file.
  29 OP_NOOP   = '-'
  30 OP_ADD    = 'A'
  31 OP_DELETE = 'D'
  32 OP_CHANGE = 'C'
  33
  34
  35 # Warnings and errors start with these strings.  They are typically
  36 # followed by a colon and a space, as in "%s: " ==> "WARNING: ".
  37 warning_prefix = "WARNING"
  38 error_prefix = "ERROR"
  39
  40
  41 class FatalException(Exception):
  42   """Exception thrown on a non-recoverable error.
  43
  44   If this exception is thrown by main(), it is caught by the global
  45   layer of the program, its string representation is printed, and the
  46   program is ended with an exit code of 1."""
  47
  48   pass
  49
  50
  51 class FatalError(FatalException):
  52   """A FatalException that prepends error_prefix to the message."""
  53
  54   def __init__(self, msg):
  55     """Use (error_prefix + ': ' + MSG + '\n') as the error message."""
  56
  57     FatalException.__init__(self, '%s: %s\n' % (error_prefix, msg,))
  58
  59
  60 def path_join(*components):
  61   """Join two or more pathname COMPONENTS, inserting '/' as needed.
  62   Empty component are skipped."""
  63
  64   return '/'.join(filter(None, components))
  65
  66
  67 def path_split(path):
  68   """Split the svn pathname PATH into a pair, (HEAD, TAIL).
  69
  70   This is similar to os.path.split(), but always uses '/' as path
  71   separator.  PATH is an svn path, which should not start with a '/'.
  72   HEAD is everything before the last slash, and TAIL is everything
  73   after.  If PATH ends in a slash, TAIL will be empty.  If there is no
  74   slash in PATH, HEAD will be empty.  If PATH is empty, both HEAD and
  75   TAIL are empty."""
  76
  77   pos = path.rfind('/')
  78   if pos == -1:
  79     return ('', path,)
  80   else:
  81     return (path[:pos], path[pos+1:],)
  82
  83
  84 # Since the unofficial set also includes [/\] we need to translate those
  85 # into ones that don't conflict with Subversion limitations.
  86 def clean_symbolic_name(name):
  87   """Return symbolic name NAME, translating characters that Subversion
  88   does not allow in a pathname."""
  89
  90   name = name.replace('/','++')
  91   name = name.replace('\\','--')
  92   return name
  93
  94
  95 def format_date(date):
  96   """Return an svn-compatible date string for DATE (seconds since epoch).
  97
  98   A Subversion date looks like '2002-09-29T14:44:59.000000Z'."""
  99
 100   return time.strftime("%Y-%m-%dT%H:%M:%S.000000Z", time.gmtime(date))
 101
 102