git-svn-keywords.py

   1 #!/usr/bin/python
   2 # -*- coding: utf-8 -*-
   3
   4 # Copyright (c) 2009 Alejandro R. Sedeño <asedeno@mit.edu>
   5
   6 # Permission is hereby granted, free of charge, to any person
   7 # obtaining a copy of this software and associated documentation files
   8 # (the "Software"), to deal in the Software without restriction,
   9 # including without limitation the rights to use, copy, modify, merge,
  10 # publish, distribute, sublicense, and/or sell copies of the Software,
  11 # and to permit persons to whom the Software is furnished to do so,
  12 # subject to the following conditions:
  13
  14 # The above copyright notice and this permission notice shall be
  15 # included in all copies or substantial portions of the Software.
  16
  17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  21 # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  22 # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  23 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24 # SOFTWARE.
  25
  26 # git svn keyword parsing, populating, and clearing.
  27
  28 from __future__ import with_statement
  29 import errno, os, re, urllib
  30 from ConfigParser import ConfigParser
  31 from optparse import OptionParser
  32 from fnmatch import fnmatch
  33 import git
  34
  35 VERSION = "0.9"
  36
  37 # Where we keep data in the repo.
  38 def gsk(g):
  39     return os.path.join(g.path, 'svn_keywords')
  40
  41 #Configuration Data
  42 CONFIG = ConfigParser()
  43 FILES = ConfigParser()
  44 FILEINFO = ConfigParser()
  45
  46 CONFIG_PATH = ''
  47 FILES_PATH = ''
  48 FILEINFO_PATH = ''
  49
  50
  51 # Valid keywords:
  52 svn_keywords = {'Date': ['Date', 'LastDateChanged'],
  53                 'Revision': ['Revision', 'LastChangedRevision', 'Rev'],
  54                 'Author': ['Author','LastChangedBy'],
  55                 'URL': ['HeadURL', 'URL'],
  56                 'Id': ['Id']
  57                 }
  58
  59 # Regular expressions we'll be using to smudge/clean; created as
  60 # needed and cached.
  61 svn_keywords_re = {}
  62 def get_svn_keyword_re(s):
  63     if not s in svn_keywords:
  64         raise 'Invalid SVN Keyword'
  65     if not s in svn_keywords_re:
  66         svn_keywords_re[s] = re.compile('\$(' + ('|'.join(svn_keywords[s])) + ')[^$]*\$')
  67     return svn_keywords_re[s]
  68
  69 # Parse the unhandled log.
  70 def _do_parse_unhandled(directory, lastrev=None):
  71     base = os.path.join(directory)
  72     rev = None
  73     for d in os.listdir(base):
  74         subent = os.path.join(base, d)
  75         if (d == 'unhandled.log' and os.path.isfile(subent)):
  76             with open(subent, 'r') as f:
  77                 # Compile the regular expressions we'll be using here.
  78                 re_rev = re.compile("^r(\d+)$")
  79                 re_keywords = re.compile("^\s+[-+]file_prop: (\S+) svn:keywords ?(\S*)$")
  80
  81                 for line in f:
  82                     m = re_rev.match(line)
  83                     if m:
  84                         rev = m.group(1)
  85                         continue
  86
  87                     if (lastrev >= int(rev)):
  88                         continue
  89
  90                     m = re_keywords.match(line)
  91                     if m:
  92                         path = urllib.unquote(m.group(1))
  93                         keywords = set(urllib.unquote(m.group(2)).split(' '))
  94                         if not FILES.has_section(path):
  95                             FILES.add_section(path)
  96                         FILES.set(path, rev, keywords)
  97         elif (os.path.isdir(subent)):
  98             _do_parse_unhandled(subent, lastrev=lastrev)
  99
 100     if rev:
 101         lastrev = max(int(rev), lastrev)
 102     CONFIG.set('core', 'lastrev', lastrev)
 103     CONFIG.set('core', 'version', VERSION)
 104
 105 def parse_svn_unhandled(g):
 106     try:
 107         os.mkdir(gsk(g))
 108     except os.error, e:
 109         if e.errno != errno.EEXIST:
 110             raise
 111
 112     ver = -1
 113     if CONFIG.has_option('core', 'version'):
 114         ver = CONFIG.get('core', 'version')
 115
 116     lastrev = None
 117     if ver == VERSION:
 118         FILES.read(FILES_PATH)
 119         if CONFIG.has_option('core', 'lastrev'):
 120             try:
 121                 lastrev = CONFIG.getint('core', 'lastrev')
 122             except ValueError:
 123                 lastrev = None
 124
 125     _do_parse_unhandled(os.path.join(g.path, 'svn'), lastrev=lastrev)
 126
 127     with open(FILES_PATH, 'wb') as f:
 128         FILES.write(f)
 129
 130     with open(CONFIG_PATH, 'wb') as f:
 131         CONFIG.write(f)
 132
 133 def get_path_info(g, path):
 134     write_config = False
 135
 136     # parse ls-tree output and get a blob id for path
 137     blob = g.git.ls_tree('HEAD', path).split(' ')[2].split("\t")[0]
 138
 139     # translate that to a commit id
 140     if not CONFIG.has_option('BlobToCommit', blob):
 141         CONFIG.set('BlobToCommit', blob, g.commits('HEAD', path, 1)[0].id)
 142         write_config = True
 143     commit = CONFIG.get('BlobToCommit', blob)
 144
 145     # tranlsate that into an svn revision id
 146     if not CONFIG.has_option('CommitToRev', commit):
 147         CONFIG.set('CommitToRev',commit,g.git.svn('find-rev', commit))
 148         write_config = True
 149     file_rev = CONFIG.get('CommitToRev', commit)
 150
 151     # get information about that revision
 152     info_dict = {}
 153     if not CONFIG.has_option('RevInfo', file_rev):
 154         for line in g.git.svn('info', path).split("\n"):
 155             k, v = line.split(": ", 1)
 156             if k == 'Last Changed Date':
 157                 info_dict['Date'] = v
 158             elif k == 'Last Changed Author':
 159                 info_dict['Author'] = v
 160         CONFIG.set('RevInfo', file_rev, info_dict)
 161         write_config = True
 162     else:
 163         info = CONFIG.get('RevInfo', file_rev)
 164         info_dict.update(info if type(info) is dict else eval(info))
 165
 166     if write_config:
 167         with open(CONFIG_PATH, 'wb') as f:
 168             CONFIG.write(f)
 169
 170     info_dict['Revision'] = file_rev
 171     return info_dict
 172
 173 def find_last_svn_rev(treeish, parent=0):
 174     svnRev = g.git.svn('find-rev', "%s~%i" % (treeish, parent))
 175     if svnRev:
 176         return int(svnRev)
 177     else:
 178         return find_last_svn_rev(treeish, parent+1)
 179
 180 # Do the work.
 181 def smudge(g, options):
 182     parse_svn_unhandled(g)
 183     rev_head = find_last_svn_rev('HEAD')
 184     url_base = g.git.svn('info', '--url')
 185
 186     FILES.read(FILES_PATH)
 187     FILEINFO.read(FILEINFO_PATH)
 188
 189     ignores = []
 190     with open(os.path.join(g.wd,'.git','info','exclude')) as f:
 191         for line in f:
 192             if line[0] != '#':
 193                 ignores.append(line.rstrip('\n'))
 194
 195     paths = FILES.sections()
 196     paths.sort()
 197     for path in paths:
 198         if not os.path.exists(path):
 199             continue
 200
 201         ignore = False
 202         for i in ignores:
 203             if fnmatch(path, i):
 204                 ignore = True
 205         if ignore:
 206             continue
 207         try:
 208             kw_rev = max(filter(lambda x: x <= rev_head, map(int, FILES.options(path))))
 209         except ValueError:
 210             continue
 211
 212         info_dict = {}
 213         if not options.clean:
 214             info_dict.update(get_path_info(g, path))
 215             info_dict['URL'] = '/'.join([url_base, path])
 216             info_dict['Name'] = os.path.basename(path)
 217             info_dict['Revision'] = str(max(kw_rev, info_dict['Revision']))
 218
 219         buf = ''
 220         with open(os.path.join(g.wd, path), 'r') as f:
 221             buf = f.read()
 222
 223         keywords = eval(FILES.get(path, str(kw_rev)))
 224         for k in keywords:
 225             for sk in svn_keywords:
 226                 if k in svn_keywords[sk]:
 227                     if options.clean:
 228                         buf = re.sub(get_svn_keyword_re(sk), '$\\1$', buf)
 229                     elif sk == 'Id':
 230                         id_str = ' '.join([info_dict['Name'],
 231                                            info_dict['Revision'],
 232                                            info_dict['Date'],
 233                                            info_dict['Author']])
 234                         buf = re.sub(get_svn_keyword_re(sk), '$\\1: ' + id_str + ' $', buf)
 235                     else:
 236                         buf = re.sub(get_svn_keyword_re(sk), '$\\1: ' + info_dict[sk] + ' $', buf)
 237
 238         with open(os.path.join(g.wd, path), 'w') as f:
 239             f.write(buf)
 240         if options.verbose:
 241             print path + ' [' + ', '.join(keywords) + '] [len: ' + str(len(buf)) +']'
 242
 243 if __name__ == '__main__':
 244
 245     parser = OptionParser(version="%prog "+str(VERSION))
 246     parser.set_defaults(clean=None)
 247     parser.add_option("-s", "--smudge",
 248                       action="store_false", dest="clean",
 249                       help="Populate svn:keywords.")
 250     parser.add_option("-c", "--clean",
 251                       action="store_true", dest="clean",
 252                       help="Return svn:keywords to pristene state.")
 253     parser.add_option("-v", "--verbose",
 254                       action="store_true", dest="verbose", default=False)
 255     (options, args) = parser.parse_args()
 256
 257     if (options.clean is None):
 258         parser.print_help()
 259         exit(0)
 260     else:
 261         try:
 262             g = git.Repo()
 263         except git.errors.InvalidGitRepositoryError:
 264             print "You are not in a git repository or working directory."
 265             exit(1)
 266
 267         CONFIG_PATH = os.path.join(gsk(g), 'conf.ini')
 268         FILES_PATH = os.path.join(gsk(g), 'files.ini')
 269         FILEINFO_PATH = os.path.join(gsk(g), 'fileinfo.ini')
 270
 271         CONFIG.read(CONFIG_PATH)
 272         for section in ['core','CommitToRev','BlobToCommit', 'RevInfo']:
 273             if not CONFIG.has_section(section):
 274                 CONFIG.add_section(section)
 275
 276         smudge(g, options)