##// END OF EJS Templates
with: use context manager for wlock in kw_amend
Bryan O'Sullivan -
r27817:476e402e default
parent child Browse files
Show More
@@ -1,743 +1,740 b''
1 1 # keyword.py - $Keyword$ expansion for Mercurial
2 2 #
3 3 # Copyright 2007-2015 Christian Ebert <blacktrash@gmx.net>
4 4 #
5 5 # This software may be used and distributed according to the terms of the
6 6 # GNU General Public License version 2 or any later version.
7 7 #
8 8 # $Id$
9 9 #
10 10 # Keyword expansion hack against the grain of a Distributed SCM
11 11 #
12 12 # There are many good reasons why this is not needed in a distributed
13 13 # SCM, still it may be useful in very small projects based on single
14 14 # files (like LaTeX packages), that are mostly addressed to an
15 15 # audience not running a version control system.
16 16 #
17 17 # For in-depth discussion refer to
18 18 # <https://mercurial-scm.org/wiki/KeywordPlan>.
19 19 #
20 20 # Keyword expansion is based on Mercurial's changeset template mappings.
21 21 #
22 22 # Binary files are not touched.
23 23 #
24 24 # Files to act upon/ignore are specified in the [keyword] section.
25 25 # Customized keyword template mappings in the [keywordmaps] section.
26 26 #
27 27 # Run "hg help keyword" and "hg kwdemo" to get info on configuration.
28 28
29 29 '''expand keywords in tracked files
30 30
31 31 This extension expands RCS/CVS-like or self-customized $Keywords$ in
32 32 tracked text files selected by your configuration.
33 33
34 34 Keywords are only expanded in local repositories and not stored in the
35 35 change history. The mechanism can be regarded as a convenience for the
36 36 current user or for archive distribution.
37 37
38 38 Keywords expand to the changeset data pertaining to the latest change
39 39 relative to the working directory parent of each file.
40 40
41 41 Configuration is done in the [keyword], [keywordset] and [keywordmaps]
42 42 sections of hgrc files.
43 43
44 44 Example::
45 45
46 46 [keyword]
47 47 # expand keywords in every python file except those matching "x*"
48 48 **.py =
49 49 x* = ignore
50 50
51 51 [keywordset]
52 52 # prefer svn- over cvs-like default keywordmaps
53 53 svn = True
54 54
55 55 .. note::
56 56
57 57 The more specific you are in your filename patterns the less you
58 58 lose speed in huge repositories.
59 59
60 60 For [keywordmaps] template mapping and expansion demonstration and
61 61 control run :hg:`kwdemo`. See :hg:`help templates` for a list of
62 62 available templates and filters.
63 63
64 64 Three additional date template filters are provided:
65 65
66 66 :``utcdate``: "2006/09/18 15:13:13"
67 67 :``svnutcdate``: "2006-09-18 15:13:13Z"
68 68 :``svnisodate``: "2006-09-18 08:13:13 -700 (Mon, 18 Sep 2006)"
69 69
70 70 The default template mappings (view with :hg:`kwdemo -d`) can be
71 71 replaced with customized keywords and templates. Again, run
72 72 :hg:`kwdemo` to control the results of your configuration changes.
73 73
74 74 Before changing/disabling active keywords, you must run :hg:`kwshrink`
75 75 to avoid storing expanded keywords in the change history.
76 76
77 77 To force expansion after enabling it, or a configuration change, run
78 78 :hg:`kwexpand`.
79 79
80 80 Expansions spanning more than one line and incremental expansions,
81 81 like CVS' $Log$, are not supported. A keyword template map "Log =
82 82 {desc}" expands to the first line of the changeset description.
83 83 '''
84 84
85 85 from mercurial import commands, context, cmdutil, dispatch, filelog, extensions
86 86 from mercurial import localrepo, match, patch, templatefilters, util, error
87 87 from mercurial import scmutil, pathutil
88 88 from mercurial.hgweb import webcommands
89 89 from mercurial.i18n import _
90 90 import os, re, tempfile
91 91
92 92 cmdtable = {}
93 93 command = cmdutil.command(cmdtable)
94 94 # Note for extension authors: ONLY specify testedwith = 'internal' for
95 95 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
96 96 # be specifying the version(s) of Mercurial they are tested with, or
97 97 # leave the attribute unspecified.
98 98 testedwith = 'internal'
99 99
100 100 # hg commands that do not act on keywords
101 101 nokwcommands = ('add addremove annotate bundle export grep incoming init log'
102 102 ' outgoing push tip verify convert email glog')
103 103
104 104 # hg commands that trigger expansion only when writing to working dir,
105 105 # not when reading filelog, and unexpand when reading from working dir
106 106 restricted = ('merge kwexpand kwshrink record qrecord resolve transplant'
107 107 ' unshelve rebase graft backout histedit fetch')
108 108
109 109 # names of extensions using dorecord
110 110 recordextensions = 'record'
111 111
112 112 colortable = {
113 113 'kwfiles.enabled': 'green bold',
114 114 'kwfiles.deleted': 'cyan bold underline',
115 115 'kwfiles.enabledunknown': 'green',
116 116 'kwfiles.ignored': 'bold',
117 117 'kwfiles.ignoredunknown': 'none'
118 118 }
119 119
120 120 # date like in cvs' $Date
121 121 def utcdate(text):
122 122 ''':utcdate: Date. Returns a UTC-date in this format: "2009/08/18 11:00:13".
123 123 '''
124 124 return util.datestr((util.parsedate(text)[0], 0), '%Y/%m/%d %H:%M:%S')
125 125 # date like in svn's $Date
126 126 def svnisodate(text):
127 127 ''':svnisodate: Date. Returns a date in this format: "2009-08-18 13:00:13
128 128 +0200 (Tue, 18 Aug 2009)".
129 129 '''
130 130 return util.datestr(text, '%Y-%m-%d %H:%M:%S %1%2 (%a, %d %b %Y)')
131 131 # date like in svn's $Id
132 132 def svnutcdate(text):
133 133 ''':svnutcdate: Date. Returns a UTC-date in this format: "2009-08-18
134 134 11:00:13Z".
135 135 '''
136 136 return util.datestr((util.parsedate(text)[0], 0), '%Y-%m-%d %H:%M:%SZ')
137 137
138 138 templatefilters.filters.update({'utcdate': utcdate,
139 139 'svnisodate': svnisodate,
140 140 'svnutcdate': svnutcdate})
141 141
142 142 # make keyword tools accessible
143 143 kwtools = {'templater': None, 'hgcmd': ''}
144 144
145 145 def _defaultkwmaps(ui):
146 146 '''Returns default keywordmaps according to keywordset configuration.'''
147 147 templates = {
148 148 'Revision': '{node|short}',
149 149 'Author': '{author|user}',
150 150 }
151 151 kwsets = ({
152 152 'Date': '{date|utcdate}',
153 153 'RCSfile': '{file|basename},v',
154 154 'RCSFile': '{file|basename},v', # kept for backwards compatibility
155 155 # with hg-keyword
156 156 'Source': '{root}/{file},v',
157 157 'Id': '{file|basename},v {node|short} {date|utcdate} {author|user}',
158 158 'Header': '{root}/{file},v {node|short} {date|utcdate} {author|user}',
159 159 }, {
160 160 'Date': '{date|svnisodate}',
161 161 'Id': '{file|basename},v {node|short} {date|svnutcdate} {author|user}',
162 162 'LastChangedRevision': '{node|short}',
163 163 'LastChangedBy': '{author|user}',
164 164 'LastChangedDate': '{date|svnisodate}',
165 165 })
166 166 templates.update(kwsets[ui.configbool('keywordset', 'svn')])
167 167 return templates
168 168
169 169 def _shrinktext(text, subfunc):
170 170 '''Helper for keyword expansion removal in text.
171 171 Depending on subfunc also returns number of substitutions.'''
172 172 return subfunc(r'$\1$', text)
173 173
174 174 def _preselect(wstatus, changed):
175 175 '''Retrieves modified and added files from a working directory state
176 176 and returns the subset of each contained in given changed files
177 177 retrieved from a change context.'''
178 178 modified = [f for f in wstatus.modified if f in changed]
179 179 added = [f for f in wstatus.added if f in changed]
180 180 return modified, added
181 181
182 182
183 183 class kwtemplater(object):
184 184 '''
185 185 Sets up keyword templates, corresponding keyword regex, and
186 186 provides keyword substitution functions.
187 187 '''
188 188
189 189 def __init__(self, ui, repo, inc, exc):
190 190 self.ui = ui
191 191 self.repo = repo
192 192 self.match = match.match(repo.root, '', [], inc, exc)
193 193 self.restrict = kwtools['hgcmd'] in restricted.split()
194 194 self.postcommit = False
195 195
196 196 kwmaps = self.ui.configitems('keywordmaps')
197 197 if kwmaps: # override default templates
198 198 self.templates = dict(kwmaps)
199 199 else:
200 200 self.templates = _defaultkwmaps(self.ui)
201 201
202 202 @util.propertycache
203 203 def escape(self):
204 204 '''Returns bar-separated and escaped keywords.'''
205 205 return '|'.join(map(re.escape, self.templates.keys()))
206 206
207 207 @util.propertycache
208 208 def rekw(self):
209 209 '''Returns regex for unexpanded keywords.'''
210 210 return re.compile(r'\$(%s)\$' % self.escape)
211 211
212 212 @util.propertycache
213 213 def rekwexp(self):
214 214 '''Returns regex for expanded keywords.'''
215 215 return re.compile(r'\$(%s): [^$\n\r]*? \$' % self.escape)
216 216
217 217 def substitute(self, data, path, ctx, subfunc):
218 218 '''Replaces keywords in data with expanded template.'''
219 219 def kwsub(mobj):
220 220 kw = mobj.group(1)
221 221 ct = cmdutil.changeset_templater(self.ui, self.repo, False, None,
222 222 self.templates[kw], '', False)
223 223 self.ui.pushbuffer()
224 224 ct.show(ctx, root=self.repo.root, file=path)
225 225 ekw = templatefilters.firstline(self.ui.popbuffer())
226 226 return '$%s: %s $' % (kw, ekw)
227 227 return subfunc(kwsub, data)
228 228
229 229 def linkctx(self, path, fileid):
230 230 '''Similar to filelog.linkrev, but returns a changectx.'''
231 231 return self.repo.filectx(path, fileid=fileid).changectx()
232 232
233 233 def expand(self, path, node, data):
234 234 '''Returns data with keywords expanded.'''
235 235 if not self.restrict and self.match(path) and not util.binary(data):
236 236 ctx = self.linkctx(path, node)
237 237 return self.substitute(data, path, ctx, self.rekw.sub)
238 238 return data
239 239
240 240 def iskwfile(self, cand, ctx):
241 241 '''Returns subset of candidates which are configured for keyword
242 242 expansion but are not symbolic links.'''
243 243 return [f for f in cand if self.match(f) and 'l' not in ctx.flags(f)]
244 244
245 245 def overwrite(self, ctx, candidates, lookup, expand, rekw=False):
246 246 '''Overwrites selected files expanding/shrinking keywords.'''
247 247 if self.restrict or lookup or self.postcommit: # exclude kw_copy
248 248 candidates = self.iskwfile(candidates, ctx)
249 249 if not candidates:
250 250 return
251 251 kwcmd = self.restrict and lookup # kwexpand/kwshrink
252 252 if self.restrict or expand and lookup:
253 253 mf = ctx.manifest()
254 254 if self.restrict or rekw:
255 255 re_kw = self.rekw
256 256 else:
257 257 re_kw = self.rekwexp
258 258 if expand:
259 259 msg = _('overwriting %s expanding keywords\n')
260 260 else:
261 261 msg = _('overwriting %s shrinking keywords\n')
262 262 for f in candidates:
263 263 if self.restrict:
264 264 data = self.repo.file(f).read(mf[f])
265 265 else:
266 266 data = self.repo.wread(f)
267 267 if util.binary(data):
268 268 continue
269 269 if expand:
270 270 parents = ctx.parents()
271 271 if lookup:
272 272 ctx = self.linkctx(f, mf[f])
273 273 elif self.restrict and len(parents) > 1:
274 274 # merge commit
275 275 # in case of conflict f is in modified state during
276 276 # merge, even if f does not differ from f in parent
277 277 for p in parents:
278 278 if f in p and not p[f].cmp(ctx[f]):
279 279 ctx = p[f].changectx()
280 280 break
281 281 data, found = self.substitute(data, f, ctx, re_kw.subn)
282 282 elif self.restrict:
283 283 found = re_kw.search(data)
284 284 else:
285 285 data, found = _shrinktext(data, re_kw.subn)
286 286 if found:
287 287 self.ui.note(msg % f)
288 288 fp = self.repo.wvfs(f, "wb", atomictemp=True)
289 289 fp.write(data)
290 290 fp.close()
291 291 if kwcmd:
292 292 self.repo.dirstate.normal(f)
293 293 elif self.postcommit:
294 294 self.repo.dirstate.normallookup(f)
295 295
296 296 def shrink(self, fname, text):
297 297 '''Returns text with all keyword substitutions removed.'''
298 298 if self.match(fname) and not util.binary(text):
299 299 return _shrinktext(text, self.rekwexp.sub)
300 300 return text
301 301
302 302 def shrinklines(self, fname, lines):
303 303 '''Returns lines with keyword substitutions removed.'''
304 304 if self.match(fname):
305 305 text = ''.join(lines)
306 306 if not util.binary(text):
307 307 return _shrinktext(text, self.rekwexp.sub).splitlines(True)
308 308 return lines
309 309
310 310 def wread(self, fname, data):
311 311 '''If in restricted mode returns data read from wdir with
312 312 keyword substitutions removed.'''
313 313 if self.restrict:
314 314 return self.shrink(fname, data)
315 315 return data
316 316
317 317 class kwfilelog(filelog.filelog):
318 318 '''
319 319 Subclass of filelog to hook into its read, add, cmp methods.
320 320 Keywords are "stored" unexpanded, and processed on reading.
321 321 '''
322 322 def __init__(self, opener, kwt, path):
323 323 super(kwfilelog, self).__init__(opener, path)
324 324 self.kwt = kwt
325 325 self.path = path
326 326
327 327 def read(self, node):
328 328 '''Expands keywords when reading filelog.'''
329 329 data = super(kwfilelog, self).read(node)
330 330 if self.renamed(node):
331 331 return data
332 332 return self.kwt.expand(self.path, node, data)
333 333
334 334 def add(self, text, meta, tr, link, p1=None, p2=None):
335 335 '''Removes keyword substitutions when adding to filelog.'''
336 336 text = self.kwt.shrink(self.path, text)
337 337 return super(kwfilelog, self).add(text, meta, tr, link, p1, p2)
338 338
339 339 def cmp(self, node, text):
340 340 '''Removes keyword substitutions for comparison.'''
341 341 text = self.kwt.shrink(self.path, text)
342 342 return super(kwfilelog, self).cmp(node, text)
343 343
344 344 def _status(ui, repo, wctx, kwt, *pats, **opts):
345 345 '''Bails out if [keyword] configuration is not active.
346 346 Returns status of working directory.'''
347 347 if kwt:
348 348 return repo.status(match=scmutil.match(wctx, pats, opts), clean=True,
349 349 unknown=opts.get('unknown') or opts.get('all'))
350 350 if ui.configitems('keyword'):
351 351 raise error.Abort(_('[keyword] patterns cannot match'))
352 352 raise error.Abort(_('no [keyword] patterns configured'))
353 353
354 354 def _kwfwrite(ui, repo, expand, *pats, **opts):
355 355 '''Selects files and passes them to kwtemplater.overwrite.'''
356 356 wctx = repo[None]
357 357 if len(wctx.parents()) > 1:
358 358 raise error.Abort(_('outstanding uncommitted merge'))
359 359 kwt = kwtools['templater']
360 360 with repo.wlock():
361 361 status = _status(ui, repo, wctx, kwt, *pats, **opts)
362 362 if status.modified or status.added or status.removed or status.deleted:
363 363 raise error.Abort(_('outstanding uncommitted changes'))
364 364 kwt.overwrite(wctx, status.clean, True, expand)
365 365
366 366 @command('kwdemo',
367 367 [('d', 'default', None, _('show default keyword template maps')),
368 368 ('f', 'rcfile', '',
369 369 _('read maps from rcfile'), _('FILE'))],
370 370 _('hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP]...'),
371 371 optionalrepo=True)
372 372 def demo(ui, repo, *args, **opts):
373 373 '''print [keywordmaps] configuration and an expansion example
374 374
375 375 Show current, custom, or default keyword template maps and their
376 376 expansions.
377 377
378 378 Extend the current configuration by specifying maps as arguments
379 379 and using -f/--rcfile to source an external hgrc file.
380 380
381 381 Use -d/--default to disable current configuration.
382 382
383 383 See :hg:`help templates` for information on templates and filters.
384 384 '''
385 385 def demoitems(section, items):
386 386 ui.write('[%s]\n' % section)
387 387 for k, v in sorted(items):
388 388 ui.write('%s = %s\n' % (k, v))
389 389
390 390 fn = 'demo.txt'
391 391 tmpdir = tempfile.mkdtemp('', 'kwdemo.')
392 392 ui.note(_('creating temporary repository at %s\n') % tmpdir)
393 393 repo = localrepo.localrepository(repo.baseui, tmpdir, True)
394 394 ui.setconfig('keyword', fn, '', 'keyword')
395 395 svn = ui.configbool('keywordset', 'svn')
396 396 # explicitly set keywordset for demo output
397 397 ui.setconfig('keywordset', 'svn', svn, 'keyword')
398 398
399 399 uikwmaps = ui.configitems('keywordmaps')
400 400 if args or opts.get('rcfile'):
401 401 ui.status(_('\n\tconfiguration using custom keyword template maps\n'))
402 402 if uikwmaps:
403 403 ui.status(_('\textending current template maps\n'))
404 404 if opts.get('default') or not uikwmaps:
405 405 if svn:
406 406 ui.status(_('\toverriding default svn keywordset\n'))
407 407 else:
408 408 ui.status(_('\toverriding default cvs keywordset\n'))
409 409 if opts.get('rcfile'):
410 410 ui.readconfig(opts.get('rcfile'))
411 411 if args:
412 412 # simulate hgrc parsing
413 413 rcmaps = ['[keywordmaps]\n'] + [a + '\n' for a in args]
414 414 fp = repo.vfs('hgrc', 'w')
415 415 fp.writelines(rcmaps)
416 416 fp.close()
417 417 ui.readconfig(repo.join('hgrc'))
418 418 kwmaps = dict(ui.configitems('keywordmaps'))
419 419 elif opts.get('default'):
420 420 if svn:
421 421 ui.status(_('\n\tconfiguration using default svn keywordset\n'))
422 422 else:
423 423 ui.status(_('\n\tconfiguration using default cvs keywordset\n'))
424 424 kwmaps = _defaultkwmaps(ui)
425 425 if uikwmaps:
426 426 ui.status(_('\tdisabling current template maps\n'))
427 427 for k, v in kwmaps.iteritems():
428 428 ui.setconfig('keywordmaps', k, v, 'keyword')
429 429 else:
430 430 ui.status(_('\n\tconfiguration using current keyword template maps\n'))
431 431 if uikwmaps:
432 432 kwmaps = dict(uikwmaps)
433 433 else:
434 434 kwmaps = _defaultkwmaps(ui)
435 435
436 436 uisetup(ui)
437 437 reposetup(ui, repo)
438 438 ui.write('[extensions]\nkeyword =\n')
439 439 demoitems('keyword', ui.configitems('keyword'))
440 440 demoitems('keywordset', ui.configitems('keywordset'))
441 441 demoitems('keywordmaps', kwmaps.iteritems())
442 442 keywords = '$' + '$\n$'.join(sorted(kwmaps.keys())) + '$\n'
443 443 repo.wvfs.write(fn, keywords)
444 444 repo[None].add([fn])
445 445 ui.note(_('\nkeywords written to %s:\n') % fn)
446 446 ui.note(keywords)
447 447 with repo.wlock():
448 448 repo.dirstate.setbranch('demobranch')
449 449 for name, cmd in ui.configitems('hooks'):
450 450 if name.split('.', 1)[0].find('commit') > -1:
451 451 repo.ui.setconfig('hooks', name, '', 'keyword')
452 452 msg = _('hg keyword configuration and expansion example')
453 453 ui.note(("hg ci -m '%s'\n" % msg))
454 454 repo.commit(text=msg)
455 455 ui.status(_('\n\tkeywords expanded\n'))
456 456 ui.write(repo.wread(fn))
457 457 repo.wvfs.rmtree(repo.root)
458 458
459 459 @command('kwexpand',
460 460 commands.walkopts,
461 461 _('hg kwexpand [OPTION]... [FILE]...'),
462 462 inferrepo=True)
463 463 def expand(ui, repo, *pats, **opts):
464 464 '''expand keywords in the working directory
465 465
466 466 Run after (re)enabling keyword expansion.
467 467
468 468 kwexpand refuses to run if given files contain local changes.
469 469 '''
470 470 # 3rd argument sets expansion to True
471 471 _kwfwrite(ui, repo, True, *pats, **opts)
472 472
473 473 @command('kwfiles',
474 474 [('A', 'all', None, _('show keyword status flags of all files')),
475 475 ('i', 'ignore', None, _('show files excluded from expansion')),
476 476 ('u', 'unknown', None, _('only show unknown (not tracked) files')),
477 477 ] + commands.walkopts,
478 478 _('hg kwfiles [OPTION]... [FILE]...'),
479 479 inferrepo=True)
480 480 def files(ui, repo, *pats, **opts):
481 481 '''show files configured for keyword expansion
482 482
483 483 List which files in the working directory are matched by the
484 484 [keyword] configuration patterns.
485 485
486 486 Useful to prevent inadvertent keyword expansion and to speed up
487 487 execution by including only files that are actual candidates for
488 488 expansion.
489 489
490 490 See :hg:`help keyword` on how to construct patterns both for
491 491 inclusion and exclusion of files.
492 492
493 493 With -A/--all and -v/--verbose the codes used to show the status
494 494 of files are::
495 495
496 496 K = keyword expansion candidate
497 497 k = keyword expansion candidate (not tracked)
498 498 I = ignored
499 499 i = ignored (not tracked)
500 500 '''
501 501 kwt = kwtools['templater']
502 502 wctx = repo[None]
503 503 status = _status(ui, repo, wctx, kwt, *pats, **opts)
504 504 if pats:
505 505 cwd = repo.getcwd()
506 506 else:
507 507 cwd = ''
508 508 files = []
509 509 if not opts.get('unknown') or opts.get('all'):
510 510 files = sorted(status.modified + status.added + status.clean)
511 511 kwfiles = kwt.iskwfile(files, wctx)
512 512 kwdeleted = kwt.iskwfile(status.deleted, wctx)
513 513 kwunknown = kwt.iskwfile(status.unknown, wctx)
514 514 if not opts.get('ignore') or opts.get('all'):
515 515 showfiles = kwfiles, kwdeleted, kwunknown
516 516 else:
517 517 showfiles = [], [], []
518 518 if opts.get('all') or opts.get('ignore'):
519 519 showfiles += ([f for f in files if f not in kwfiles],
520 520 [f for f in status.unknown if f not in kwunknown])
521 521 kwlabels = 'enabled deleted enabledunknown ignored ignoredunknown'.split()
522 522 kwstates = zip(kwlabels, 'K!kIi', showfiles)
523 523 fm = ui.formatter('kwfiles', opts)
524 524 fmt = '%.0s%s\n'
525 525 if opts.get('all') or ui.verbose:
526 526 fmt = '%s %s\n'
527 527 for kwstate, char, filenames in kwstates:
528 528 label = 'kwfiles.' + kwstate
529 529 for f in filenames:
530 530 fm.startitem()
531 531 fm.write('kwstatus path', fmt, char,
532 532 repo.pathto(f, cwd), label=label)
533 533 fm.end()
534 534
535 535 @command('kwshrink',
536 536 commands.walkopts,
537 537 _('hg kwshrink [OPTION]... [FILE]...'),
538 538 inferrepo=True)
539 539 def shrink(ui, repo, *pats, **opts):
540 540 '''revert expanded keywords in the working directory
541 541
542 542 Must be run before changing/disabling active keywords.
543 543
544 544 kwshrink refuses to run if given files contain local changes.
545 545 '''
546 546 # 3rd argument sets expansion to False
547 547 _kwfwrite(ui, repo, False, *pats, **opts)
548 548
549 549
550 550 def uisetup(ui):
551 551 ''' Monkeypatches dispatch._parse to retrieve user command.'''
552 552
553 553 def kwdispatch_parse(orig, ui, args):
554 554 '''Monkeypatch dispatch._parse to obtain running hg command.'''
555 555 cmd, func, args, options, cmdoptions = orig(ui, args)
556 556 kwtools['hgcmd'] = cmd
557 557 return cmd, func, args, options, cmdoptions
558 558
559 559 extensions.wrapfunction(dispatch, '_parse', kwdispatch_parse)
560 560
561 561 def reposetup(ui, repo):
562 562 '''Sets up repo as kwrepo for keyword substitution.
563 563 Overrides file method to return kwfilelog instead of filelog
564 564 if file matches user configuration.
565 565 Wraps commit to overwrite configured files with updated
566 566 keyword substitutions.
567 567 Monkeypatches patch and webcommands.'''
568 568
569 569 try:
570 570 if (not repo.local() or kwtools['hgcmd'] in nokwcommands.split()
571 571 or '.hg' in util.splitpath(repo.root)
572 572 or repo._url.startswith('bundle:')):
573 573 return
574 574 except AttributeError:
575 575 pass
576 576
577 577 inc, exc = [], ['.hg*']
578 578 for pat, opt in ui.configitems('keyword'):
579 579 if opt != 'ignore':
580 580 inc.append(pat)
581 581 else:
582 582 exc.append(pat)
583 583 if not inc:
584 584 return
585 585
586 586 kwtools['templater'] = kwt = kwtemplater(ui, repo, inc, exc)
587 587
588 588 class kwrepo(repo.__class__):
589 589 def file(self, f):
590 590 if f[0] == '/':
591 591 f = f[1:]
592 592 return kwfilelog(self.svfs, kwt, f)
593 593
594 594 def wread(self, filename):
595 595 data = super(kwrepo, self).wread(filename)
596 596 return kwt.wread(filename, data)
597 597
598 598 def commit(self, *args, **opts):
599 599 # use custom commitctx for user commands
600 600 # other extensions can still wrap repo.commitctx directly
601 601 self.commitctx = self.kwcommitctx
602 602 try:
603 603 return super(kwrepo, self).commit(*args, **opts)
604 604 finally:
605 605 del self.commitctx
606 606
607 607 def kwcommitctx(self, ctx, error=False):
608 608 n = super(kwrepo, self).commitctx(ctx, error)
609 609 # no lock needed, only called from repo.commit() which already locks
610 610 if not kwt.postcommit:
611 611 restrict = kwt.restrict
612 612 kwt.restrict = True
613 613 kwt.overwrite(self[n], sorted(ctx.added() + ctx.modified()),
614 614 False, True)
615 615 kwt.restrict = restrict
616 616 return n
617 617
618 618 def rollback(self, dryrun=False, force=False):
619 619 wlock = self.wlock()
620 620 origrestrict = kwt.restrict
621 621 try:
622 622 if not dryrun:
623 623 changed = self['.'].files()
624 624 ret = super(kwrepo, self).rollback(dryrun, force)
625 625 if not dryrun:
626 626 ctx = self['.']
627 627 modified, added = _preselect(ctx.status(), changed)
628 628 kwt.restrict = False
629 629 kwt.overwrite(ctx, modified, True, True)
630 630 kwt.overwrite(ctx, added, True, False)
631 631 return ret
632 632 finally:
633 633 kwt.restrict = origrestrict
634 634 wlock.release()
635 635
636 636 # monkeypatches
637 637 def kwpatchfile_init(orig, self, ui, gp, backend, store, eolmode=None):
638 638 '''Monkeypatch/wrap patch.patchfile.__init__ to avoid
639 639 rejects or conflicts due to expanded keywords in working dir.'''
640 640 orig(self, ui, gp, backend, store, eolmode)
641 641 # shrink keywords read from working dir
642 642 self.lines = kwt.shrinklines(self.fname, self.lines)
643 643
644 644 def kwdiff(orig, *args, **kwargs):
645 645 '''Monkeypatch patch.diff to avoid expansion.'''
646 646 kwt.restrict = True
647 647 return orig(*args, **kwargs)
648 648
649 649 def kwweb_skip(orig, web, req, tmpl):
650 650 '''Wraps webcommands.x turning off keyword expansion.'''
651 651 kwt.match = util.never
652 652 return orig(web, req, tmpl)
653 653
654 654 def kw_amend(orig, ui, repo, commitfunc, old, extra, pats, opts):
655 655 '''Wraps cmdutil.amend expanding keywords after amend.'''
656 wlock = repo.wlock()
657 try:
656 with repo.wlock():
658 657 kwt.postcommit = True
659 658 newid = orig(ui, repo, commitfunc, old, extra, pats, opts)
660 659 if newid != old.node():
661 660 ctx = repo[newid]
662 661 kwt.restrict = True
663 662 kwt.overwrite(ctx, ctx.files(), False, True)
664 663 kwt.restrict = False
665 664 return newid
666 finally:
667 wlock.release()
668 665
669 666 def kw_copy(orig, ui, repo, pats, opts, rename=False):
670 667 '''Wraps cmdutil.copy so that copy/rename destinations do not
671 668 contain expanded keywords.
672 669 Note that the source of a regular file destination may also be a
673 670 symlink:
674 671 hg cp sym x -> x is symlink
675 672 cp sym x; hg cp -A sym x -> x is file (maybe expanded keywords)
676 673 For the latter we have to follow the symlink to find out whether its
677 674 target is configured for expansion and we therefore must unexpand the
678 675 keywords in the destination.'''
679 676 wlock = repo.wlock()
680 677 try:
681 678 orig(ui, repo, pats, opts, rename)
682 679 if opts.get('dry_run'):
683 680 return
684 681 wctx = repo[None]
685 682 cwd = repo.getcwd()
686 683
687 684 def haskwsource(dest):
688 685 '''Returns true if dest is a regular file and configured for
689 686 expansion or a symlink which points to a file configured for
690 687 expansion. '''
691 688 source = repo.dirstate.copied(dest)
692 689 if 'l' in wctx.flags(source):
693 690 source = pathutil.canonpath(repo.root, cwd,
694 691 os.path.realpath(source))
695 692 return kwt.match(source)
696 693
697 694 candidates = [f for f in repo.dirstate.copies() if
698 695 'l' not in wctx.flags(f) and haskwsource(f)]
699 696 kwt.overwrite(wctx, candidates, False, False)
700 697 finally:
701 698 wlock.release()
702 699
703 700 def kw_dorecord(orig, ui, repo, commitfunc, *pats, **opts):
704 701 '''Wraps record.dorecord expanding keywords after recording.'''
705 702 wlock = repo.wlock()
706 703 try:
707 704 # record returns 0 even when nothing has changed
708 705 # therefore compare nodes before and after
709 706 kwt.postcommit = True
710 707 ctx = repo['.']
711 708 wstatus = ctx.status()
712 709 ret = orig(ui, repo, commitfunc, *pats, **opts)
713 710 recctx = repo['.']
714 711 if ctx != recctx:
715 712 modified, added = _preselect(wstatus, recctx.files())
716 713 kwt.restrict = False
717 714 kwt.overwrite(recctx, modified, False, True)
718 715 kwt.overwrite(recctx, added, False, True, True)
719 716 kwt.restrict = True
720 717 return ret
721 718 finally:
722 719 wlock.release()
723 720
724 721 def kwfilectx_cmp(orig, self, fctx):
725 722 # keyword affects data size, comparing wdir and filelog size does
726 723 # not make sense
727 724 if (fctx._filerev is None and
728 725 (self._repo._encodefilterpats or
729 726 kwt.match(fctx.path()) and 'l' not in fctx.flags() or
730 727 self.size() - 4 == fctx.size()) or
731 728 self.size() == fctx.size()):
732 729 return self._filelog.cmp(self._filenode, fctx.data())
733 730 return True
734 731
735 732 extensions.wrapfunction(context.filectx, 'cmp', kwfilectx_cmp)
736 733 extensions.wrapfunction(patch.patchfile, '__init__', kwpatchfile_init)
737 734 extensions.wrapfunction(patch, 'diff', kwdiff)
738 735 extensions.wrapfunction(cmdutil, 'amend', kw_amend)
739 736 extensions.wrapfunction(cmdutil, 'copy', kw_copy)
740 737 extensions.wrapfunction(cmdutil, 'dorecord', kw_dorecord)
741 738 for c in 'annotate changeset rev filediff diff'.split():
742 739 extensions.wrapfunction(webcommands, c, kwweb_skip)
743 740 repo.__class__ = kwrepo
General Comments 0
You need to be logged in to leave comments. Login now