cvs2svn_lib/property_setters.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 """This module contains classes to set Subversion properties on files."""
  18
  19
  20 import os
  21 import re
  22 import fnmatch
  23 import ConfigParser
  24 from cStringIO import StringIO
  25
  26 from cvs2svn_lib.common import warning_prefix
  27 from cvs2svn_lib.log import Log
  28
  29
  30 class SVNPropertySetter:
  31   """Abstract class for objects that can set properties on a SVNCommitItem."""
  32
  33   def set_properties(self, s_item):
  34     """Set any properties that can be determined for S_ITEM.
  35
  36     S_ITEM is an instance of SVNCommitItem.  This method should modify
  37     S_ITEM.svn_props in place."""
  38
  39     raise NotImplementedError
  40
  41
  42 class CVSRevisionNumberSetter(SVNPropertySetter):
  43   """Store the CVS revision number to an SVN property."""
  44
  45   def __init__(self, propname='cvs2svn:cvs-rev'):
  46     self.propname = propname
  47
  48   def set_properties(self, s_item):
  49     if self.propname in s_item.svn_props:
  50       return
  51
  52     s_item.svn_props[self.propname] = s_item.cvs_rev.rev
  53     s_item.svn_props_changed = True
  54
  55
  56 class ExecutablePropertySetter(SVNPropertySetter):
  57   """Set the svn:executable property based on cvs_rev.cvs_file.executable."""
  58
  59   propname = 'svn:executable'
  60
  61   def set_properties(self, s_item):
  62     if self.propname in s_item.svn_props:
  63       return
  64
  65     if s_item.cvs_rev.cvs_file.executable:
  66       s_item.svn_props[self.propname] = '*'
  67
  68
  69 class DescriptionPropertySetter(SVNPropertySetter):
  70   """Set the svn:description property based on cvs_rev.cvs_file.description."""
  71
  72   def __init__(self, propname='cvs:description'):
  73     self.propname = propname
  74
  75   def set_properties(self, s_item):
  76     if self.propname in s_item.svn_props:
  77       return
  78
  79     if s_item.cvs_rev.cvs_file.description:
  80       s_item.svn_props[self.propname] = s_item.cvs_rev.cvs_file.description
  81
  82
  83 class CVSBinaryFileEOLStyleSetter(SVNPropertySetter):
  84   """Set the eol-style to None for files with CVS mode '-kb'."""
  85
  86   propname = 'svn:eol-style'
  87
  88   def set_properties(self, s_item):
  89     if self.propname in s_item.svn_props:
  90       return
  91
  92     if s_item.cvs_rev.cvs_file.mode == 'b':
  93       s_item.svn_props[self.propname] = None
  94
  95
  96 class MimeMapper(SVNPropertySetter):
  97   """A class that provides mappings from file names to MIME types."""
  98
  99   propname = 'svn:mime-type'
 100
 101   def __init__(self, mime_types_file):
 102     self.mappings = { }
 103
 104     for line in file(mime_types_file):
 105       if line.startswith("#"):
 106         continue
 107
 108       # format of a line is something like
 109       # text/plain c h cpp
 110       extensions = line.split()
 111       if len(extensions) < 2:
 112         continue
 113       type = extensions.pop(0)
 114       for ext in extensions:
 115         if ext in self.mappings and self.mappings[ext] != type:
 116           Log().error(
 117               "%s: ambiguous MIME mapping for *.%s (%s or %s)\n"
 118               % (warning_prefix, ext, self.mappings[ext], type)
 119               )
 120         self.mappings[ext] = type
 121
 122   def set_properties(self, s_item):
 123     if self.propname in s_item.svn_props:
 124       return
 125
 126     basename, extension = os.path.splitext(s_item.cvs_rev.cvs_file.basename)
 127
 128     # Extension includes the dot, so strip it (will leave extension
 129     # empty if filename ends with a dot, which is ok):
 130     extension = extension[1:]
 131
 132     # If there is no extension (or the file ends with a period), use
 133     # the base name for mapping.  This allows us to set mappings for
 134     # files such as README or Makefile:
 135     if not extension:
 136       extension = basename
 137
 138     mime_type = self.mappings.get(extension, None)
 139     if mime_type is not None:
 140       s_item.svn_props[self.propname] = mime_type
 141
 142
 143 class AutoPropsPropertySetter(SVNPropertySetter):
 144   """Set arbitrary svn properties based on an auto-props configuration.
 145
 146   This class supports case-sensitive or case-insensitive pattern
 147   matching.  The command-line default is case-insensitive behavior,
 148   consistent with Subversion (see
 149   http://subversion.tigris.org/issues/show_bug.cgi?id=2036).
 150
 151   As a special extension to Subversion's auto-props handling, if a
 152   property name is preceded by a '!' then that property is forced to
 153   be left unset.
 154
 155   If a property specified in auto-props has already been set to a
 156   different value, print a warning and leave the old property value
 157   unchanged.
 158
 159   Python's treatment of whitespaces in the ConfigParser module is
 160   buggy and inconsistent.  Usually spaces are preserved, but if there
 161   is at least one semicolon in the value, and the *first* semicolon is
 162   preceded by a space, then that is treated as the start of a comment
 163   and the rest of the line is silently discarded."""
 164
 165   property_name_pattern = r'(?P<name>[^\!\=\s]+)'
 166   property_unset_re = re.compile(
 167       r'^\!\s*' + property_name_pattern + r'$'
 168       )
 169   property_set_re = re.compile(
 170       r'^' + property_name_pattern + r'\s*\=\s*(?P<value>.*)$'
 171       )
 172   property_novalue_re = re.compile(
 173       r'^' + property_name_pattern + r'$'
 174       )
 175
 176   quoted_re = re.compile(
 177       r'^([\'\"]).*\1$'
 178       )
 179   comment_re = re.compile(r'\s;')
 180
 181   class Pattern:
 182     """Describes the properties to be set for files matching a pattern."""
 183
 184     def __init__(self, pattern, propdict):
 185       # A glob-like pattern:
 186       self.pattern = pattern
 187       # A dictionary of properties that should be set:
 188       self.propdict = propdict
 189
 190     def match(self, basename):
 191       """Does the file with the specified basename match pattern?"""
 192
 193       return fnmatch.fnmatch(basename, self.pattern)
 194
 195   def __init__(self, configfilename, ignore_case=True):
 196     config = ConfigParser.ConfigParser()
 197     if ignore_case:
 198       self.transform_case = self.squash_case
 199     else:
 200       config.optionxform = self.preserve_case
 201       self.transform_case = self.preserve_case
 202
 203     configtext = open(configfilename).read()
 204     if self.comment_re.search(configtext):
 205       Log().warn(
 206           '%s: Please be aware that a space followed by a\n'
 207           'semicolon is sometimes treated as a comment in configuration\n'
 208           'files.  This pattern was seen in\n'
 209           '    %s\n'
 210           'Please make sure that you have not inadvertently commented\n'
 211           'out part of an important line.'
 212           % (warning_prefix, configfilename,)
 213           )
 214
 215     config.readfp(StringIO(configtext), configfilename)
 216     self.patterns = []
 217     sections = config.sections()
 218     sections.sort()
 219     for section in sections:
 220       if self.transform_case(section) == 'auto-props':
 221         patterns = config.options(section)
 222         patterns.sort()
 223         for pattern in patterns:
 224           value = config.get(section, pattern)
 225           if value:
 226             self._add_pattern(pattern, value)
 227
 228   def squash_case(self, s):
 229     return s.lower()
 230
 231   def preserve_case(self, s):
 232     return s
 233
 234   def _add_pattern(self, pattern, props):
 235     propdict = {}
 236     if self.quoted_re.match(pattern):
 237       Log().warn(
 238           '%s: Quoting is not supported in auto-props; please verify rule\n'
 239           'for %r.  (Using pattern including quotation marks.)\n'
 240           % (warning_prefix, pattern,)
 241           )
 242     for prop in props.split(';'):
 243       prop = prop.strip()
 244       m = self.property_unset_re.match(prop)
 245       if m:
 246         name = m.group('name')
 247         Log().debug(
 248             'auto-props: For %r, leaving %r unset.' % (pattern, name,)
 249             )
 250         propdict[name] = None
 251         continue
 252
 253       m = self.property_set_re.match(prop)
 254       if m:
 255         name = m.group('name')
 256         value = m.group('value')
 257         if self.quoted_re.match(value):
 258           Log().warn(
 259               '%s: Quoting is not supported in auto-props; please verify\n'
 260               'rule %r for pattern %r.  (Using value\n'
 261               'including quotation marks.)\n'
 262               % (warning_prefix, prop, pattern,)
 263               )
 264         Log().debug(
 265             'auto-props: For %r, setting %r to %r.' % (pattern, name, value,)
 266             )
 267         propdict[name] = value
 268         continue
 269
 270       m = self.property_novalue_re.match(prop)
 271       if m:
 272         name = m.group('name')
 273         Log().debug(
 274             'auto-props: For %r, setting %r to the empty string'
 275             % (pattern, name,)
 276             )
 277         propdict[name] = ''
 278         continue
 279
 280       Log().warn(
 281           '%s: in auto-props line for %r, value %r cannot be parsed (ignored)'
 282           % (warning_prefix, pattern, prop,)
 283           )
 284
 285     self.patterns.append(self.Pattern(self.transform_case(pattern), propdict))
 286
 287   def get_propdict(self, cvs_file):
 288     basename = self.transform_case(cvs_file.basename)
 289     propdict = {}
 290     for pattern in self.patterns:
 291       if pattern.match(basename):
 292         for (key,value) in pattern.propdict.items():
 293           if key in propdict:
 294             if propdict[key] != value:
 295               Log().warn(
 296                   "Contradictory values set for property '%s' for file %s."
 297                   % (key, cvs_file,))
 298           else:
 299             propdict[key] = value
 300
 301     return propdict
 302
 303   def set_properties(self, s_item):
 304     propdict = self.get_propdict(s_item.cvs_rev.cvs_file)
 305     for (k,v) in propdict.items():
 306       if k in s_item.svn_props:
 307         if s_item.svn_props[k] != v:
 308           Log().warn(
 309               "Property '%s' already set to %r for file %s; "
 310               "auto-props value (%r) ignored."
 311               % (k, s_item.svn_props[k], s_item.cvs_rev.cvs_path, v,))
 312       else:
 313         s_item.svn_props[k] = v
 314
 315
 316 class CVSBinaryFileDefaultMimeTypeSetter(SVNPropertySetter):
 317   """If the file is binary and its svn:mime-type property is not yet
 318   set, set it to 'application/octet-stream'."""
 319
 320   propname = 'svn:mime-type'
 321
 322   def set_properties(self, s_item):
 323     if self.propname in s_item.svn_props:
 324       return
 325
 326     if s_item.cvs_rev.cvs_file.mode == 'b':
 327       s_item.svn_props[self.propname] = 'application/octet-stream'
 328
 329
 330 class EOLStyleFromMimeTypeSetter(SVNPropertySetter):
 331   """Set svn:eol-style based on svn:mime-type.
 332
 333   If svn:mime-type is known but svn:eol-style is not, then set
 334   svn:eol-style based on svn:mime-type as follows: if svn:mime-type
 335   starts with 'text/', then set svn:eol-style to native; otherwise,
 336   force it to remain unset.  See also issue #39."""
 337
 338   propname = 'svn:eol-style'
 339
 340   def set_properties(self, s_item):
 341     if self.propname in s_item.svn_props:
 342       return
 343
 344     if s_item.svn_props.get('svn:mime-type', None) is not None:
 345       if s_item.svn_props['svn:mime-type'].startswith("text/"):
 346         s_item.svn_props[self.propname] = 'native'
 347       else:
 348         s_item.svn_props[self.propname] = None
 349
 350
 351 class DefaultEOLStyleSetter(SVNPropertySetter):
 352   """Set the eol-style if one has not already been set."""
 353
 354   propname = 'svn:eol-style'
 355
 356   def __init__(self, value):
 357     """Initialize with the specified default VALUE."""
 358
 359     self.value = value
 360
 361   def set_properties(self, s_item):
 362     if self.propname in s_item.svn_props:
 363       return
 364
 365     s_item.svn_props[self.propname] = self.value
 366
 367
 368 class SVNBinaryFileKeywordsPropertySetter(SVNPropertySetter):
 369   """Turn off svn:keywords for files with binary svn:eol-style."""
 370
 371   propname = 'svn:keywords'
 372
 373   def set_properties(self, s_item):
 374     if self.propname in s_item.svn_props:
 375       return
 376
 377     if not s_item.svn_props.get('svn:eol-style'):
 378       s_item.svn_props[self.propname] = None
 379
 380
 381 class KeywordsPropertySetter(SVNPropertySetter):
 382   """If the svn:keywords property is not yet set, set it based on the
 383   file's mode.  See issue #2."""
 384
 385   propname = 'svn:keywords'
 386
 387   def __init__(self, value):
 388     """Use VALUE for the value of the svn:keywords property if it is
 389     to be set."""
 390
 391     self.value = value
 392
 393   def set_properties(self, s_item):
 394     if self.propname in s_item.svn_props:
 395       return
 396
 397     if s_item.cvs_rev.cvs_file.mode in [None, 'kv', 'kvl']:
 398       s_item.svn_props[self.propname] = self.value
 399
 400