1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
# Copyright (C) 2005 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
# XXX: Can we do any better about making interrupted commits change
# nothing? Perhaps the best approach is to integrate commit of
# AtomicFiles with releasing the lock on the Branch.
# TODO: Separate 'prepare' phase where we find a list of potentially
# committed files. We then can then pause the commit to prompt for a
# commit message, knowing the summary will be the same as what's
# actually used for the commit. (But perhaps simpler to simply get
# the tree status, then use that for a selective commit?)
# The newly committed revision is going to have a shape corresponding
# to that of the working inventory. Files that are not in the
# working tree and that were in the predecessor are reported as
# removed --- this can include files that were either removed from the
# inventory or deleted in the working tree. If they were only
# deleted from disk, they are removed from the working inventory.
# We then consider the remaining entries, which will be in the new
# version. Directory entries are simply copied across. File entries
# must be checked to see if a new version of the file should be
# recorded. For each parent revision inventory, we check to see what
# version of the file was present. If the file was present in at
# least one tree, and if it was the same version in all the trees,
# then we can just refer to that version. Otherwise, a new version
# representing the merger of the file versions must be added.
# TODO: Update hashcache before and after - or does the WorkingTree
# look after that?
# TODO: Rather than mashing together the ancestry and storing it back,
# perhaps the weave should have single method which does it all in one
# go, avoiding a lot of redundant work.
# TODO: Perhaps give a warning if one of the revisions marked as
# merged is already in the ancestry, and then don't record it as a
# distinct parent.
# TODO: If the file is newly merged but unchanged from the version it
# merges from, then it should still be reported as newly added
# relative to the basis revision.
# TODO: Do checks that the tree can be committed *before* running the
# editor; this should include checks for a pointless commit and for
# unknown or missing files.
# TODO: If commit fails, leave the message in a file somewhere.
import os
import re
import sys
import time
import pdb
from binascii import hexlify
from cStringIO import StringIO
from bzrlib.osutils import (local_time_offset,
rand_bytes, compact_date,
kind_marker, is_inside_any, quotefn,
sha_string, sha_strings, sha_file, isdir, isfile,
split_lines)
from bzrlib.branch import gen_file_id
import bzrlib.config
from bzrlib.errors import (BzrError, PointlessCommit,
HistoryMissing,
ConflictsInTree,
StrictCommitFailed
)
import bzrlib.gpg as gpg
from bzrlib.revision import Revision
from bzrlib.testament import Testament
from bzrlib.trace import mutter, note, warning
from bzrlib.xml5 import serializer_v5
from bzrlib.inventory import Inventory, ROOT_ID
from bzrlib.weave import Weave
from bzrlib.weavefile import read_weave, write_weave_v5
from bzrlib.atomicfile import AtomicFile
def commit(*args, **kwargs):
"""Commit a new revision to a branch.
Function-style interface for convenience of old callers.
New code should use the Commit class instead.
"""
## XXX: Remove this in favor of Branch.commit?
Commit().commit(*args, **kwargs)
class NullCommitReporter(object):
"""I report on progress of a commit."""
def snapshot_change(self, change, path):
pass
def completed(self, revno, rev_id):
pass
def deleted(self, file_id):
pass
def escaped(self, escape_count, message):
pass
def missing(self, path):
pass
class ReportCommitToLog(NullCommitReporter):
def snapshot_change(self, change, path):
note("%s %s", change, path)
def completed(self, revno, rev_id):
note('committed r%d {%s}', revno, rev_id)
def deleted(self, file_id):
note('deleted %s', file_id)
def escaped(self, escape_count, message):
note("replaced %d control characters in message", escape_count)
def missing(self, path):
note('missing %s', path)
class Commit(object):
"""Task of committing a new revision.
This is a MethodObject: it accumulates state as the commit is
prepared, and then it is discarded. It doesn't represent
historical revisions, just the act of recording a new one.
missing_ids
Modified to hold a list of files that have been deleted from
the working directory; these should be removed from the
working inventory.
"""
def __init__(self,
reporter=None,
config=None):
if reporter is not None:
self.reporter = reporter
else:
self.reporter = NullCommitReporter()
if config is not None:
self.config = config
else:
self.config = None
def commit(self,
branch, message,
timestamp=None,
timezone=None,
committer=None,
specific_files=None,
rev_id=None,
allow_pointless=True,
strict=False,
verbose=False,
revprops=None):
"""Commit working copy as a new revision.
timestamp -- if not None, seconds-since-epoch for a
postdated/predated commit.
specific_files -- If true, commit only those files.
rev_id -- If set, use this as the new revision id.
Useful for test or import commands that need to tightly
control what revisions are assigned. If you duplicate
a revision id that exists elsewhere it is your own fault.
If null (default), a time/random revision id is generated.
allow_pointless -- If true (default), commit even if nothing
has changed and no merges are recorded.
strict -- If true, don't allow a commit if the working tree
contains unknown files.
revprops -- Properties for new revision
"""
mutter('preparing to commit')
self.branch = branch
self.weave_store = branch.weave_store
self.rev_id = rev_id
self.specific_files = specific_files
self.allow_pointless = allow_pointless
self.revprops = revprops
if strict and branch.unknowns():
raise StrictCommitFailed()
if timestamp is None:
self.timestamp = time.time()
else:
self.timestamp = long(timestamp)
if self.config is None:
self.config = bzrlib.config.BranchConfig(self.branch)
if rev_id is None:
self.rev_id = _gen_revision_id(self.config, self.timestamp)
else:
self.rev_id = rev_id
if committer is None:
self.committer = self.config.username()
else:
assert isinstance(committer, basestring), type(committer)
self.committer = committer
if timezone is None:
self.timezone = local_time_offset()
else:
self.timezone = int(timezone)
assert isinstance(message, basestring), type(message)
self.message = message
self._escape_commit_message()
self.branch.lock_write()
try:
self.work_tree = self.branch.working_tree()
self.work_inv = self.work_tree.inventory
self.basis_tree = self.branch.basis_tree()
self.basis_inv = self.basis_tree.inventory
self._gather_parents()
if len(self.parents) > 1 and self.specific_files:
raise NotImplementedError('selected-file commit of merges is not supported yet')
self._check_parents_present()
self._remove_deleted()
self._populate_new_inv()
self._store_snapshot()
self._report_deletes()
if not (self.allow_pointless
or len(self.parents) > 1
or self.new_inv != self.basis_inv):
raise PointlessCommit()
if len(list(self.work_tree.iter_conflicts()))>0:
raise ConflictsInTree
self._record_inventory()
self._make_revision()
self.reporter.completed(self.branch.revno()+1, self.rev_id)
self.branch.append_revision(self.rev_id)
self.branch.set_pending_merges([])
finally:
self.branch.unlock()
def _record_inventory(self):
"""Store the inventory for the new revision."""
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
self.inv_sha1 = sha_string(inv_text)
s = self.branch.control_weaves
s.add_text('inventory', self.rev_id,
split_lines(inv_text), self.present_parents,
self.branch.get_transaction())
def _escape_commit_message(self):
"""Replace xml-incompatible control characters."""
# Python strings can include characters that can't be
# represented in well-formed XML; escape characters that
# aren't listed in the XML specification
# (http://www.w3.org/TR/REC-xml/#NT-Char).
if isinstance(self.message, unicode):
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
else:
# Use a regular 'str' as pattern to avoid having re.subn
# return 'unicode' results.
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
self.message, escape_count = re.subn(
char_pattern,
lambda match: match.group(0).encode('unicode_escape'),
self.message)
if escape_count:
self.reporter.escaped(escape_count, self.message)
def _gather_parents(self):
"""Record the parents of a merge for merge detection."""
pending_merges = self.branch.pending_merges()
self.parents = []
self.parent_invs = []
self.present_parents = []
precursor_id = self.branch.last_revision()
if precursor_id:
self.parents.append(precursor_id)
self.parents += pending_merges
for revision in self.parents:
if self.branch.has_revision(revision):
self.parent_invs.append(self.branch.get_inventory(revision))
self.present_parents.append(revision)
def _check_parents_present(self):
for parent_id in self.parents:
mutter('commit parent revision {%s}', parent_id)
if not self.branch.has_revision(parent_id):
if parent_id == self.branch.last_revision():
warning("parent is missing %r", parent_id)
raise HistoryMissing(self.branch, 'revision', parent_id)
else:
mutter("commit will ghost revision %r", parent_id)
def _make_revision(self):
"""Record a new revision object for this commit."""
self.rev = Revision(timestamp=self.timestamp,
timezone=self.timezone,
committer=self.committer,
message=self.message,
inventory_sha1=self.inv_sha1,
revision_id=self.rev_id,
properties=self.revprops)
self.rev.parent_ids = self.parents
rev_tmp = StringIO()
serializer_v5.write_revision(self.rev, rev_tmp)
rev_tmp.seek(0)
if self.config.signature_needed():
plaintext = Testament(self.rev, self.new_inv).as_short_text()
self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
plaintext, self.rev_id)
self.branch.revision_store.add(rev_tmp, self.rev_id)
mutter('new revision_id is {%s}', self.rev_id)
def _remove_deleted(self):
"""Remove deleted files from the working inventories.
This is done prior to taking the working inventory as the
basis for the new committed inventory.
This returns true if any files
*that existed in the basis inventory* were deleted.
Files that were added and deleted
in the working copy don't matter.
"""
specific = self.specific_files
deleted_ids = []
for path, ie in self.work_inv.iter_entries():
if specific and not is_inside_any(specific, path):
continue
if not self.work_tree.has_filename(path):
self.reporter.missing(path)
deleted_ids.append((path, ie.file_id))
if deleted_ids:
deleted_ids.sort(reverse=True)
for path, file_id in deleted_ids:
del self.work_inv[file_id]
self.branch._write_inventory(self.work_inv)
def _store_snapshot(self):
"""Pass over inventory and record a snapshot.
Entries get a new revision when they are modified in
any way, which includes a merge with a new set of
parents that have the same entry.
"""
# XXX: Need to think more here about when the user has
# made a specific decision on a particular value -- c.f.
# mark-merge.
for path, ie in self.new_inv.iter_entries():
previous_entries = ie.find_previous_heads(
self.parent_invs,
self.weave_store.get_weave_or_empty(ie.file_id,
self.branch.get_transaction()))
if ie.revision is None:
change = ie.snapshot(self.rev_id, path, previous_entries,
self.work_tree, self.weave_store,
self.branch.get_transaction())
else:
change = "unchanged"
self.reporter.snapshot_change(change, path)
def _populate_new_inv(self):
"""Build revision inventory.
This creates a new empty inventory. Depending on
which files are selected for commit, and what is present in the
current tree, the new inventory is populated. inventory entries
which are candidates for modification have their revision set to
None; inventory entries that are carried over untouched have their
revision set to their prior value.
"""
mutter("Selecting files for commit with filter %s", self.specific_files)
self.new_inv = Inventory()
for path, new_ie in self.work_inv.iter_entries():
file_id = new_ie.file_id
mutter('check %s {%s}', path, new_ie.file_id)
if self.specific_files:
if not is_inside_any(self.specific_files, path):
mutter('%s not selected for commit', path)
self._carry_entry(file_id)
continue
else:
# this is selected, ensure its parents are too.
parent_id = new_ie.parent_id
while parent_id != ROOT_ID:
if not self.new_inv.has_id(parent_id):
ie = self._select_entry(self.work_inv[parent_id])
mutter('%s selected for commit because of %s',
self.new_inv.id2path(parent_id), path)
ie = self.new_inv[parent_id]
if ie.revision is not None:
ie.revision = None
mutter('%s selected for commit because of %s',
self.new_inv.id2path(parent_id), path)
parent_id = ie.parent_id
mutter('%s selected for commit', path)
self._select_entry(new_ie)
def _select_entry(self, new_ie):
"""Make new_ie be considered for committing."""
ie = new_ie.copy()
ie.revision = None
self.new_inv.add(ie)
return ie
def _carry_entry(self, file_id):
"""Carry the file unchanged from the basis revision."""
if self.basis_inv.has_id(file_id):
self.new_inv.add(self.basis_inv[file_id].copy())
def _report_deletes(self):
for file_id in self.basis_inv:
if file_id not in self.new_inv:
self.reporter.deleted(self.basis_inv.id2path(file_id))
def _gen_revision_id(config, when):
"""Return new revision-id."""
s = '%s-%s-' % (config.user_email(), compact_date(when))
s += hexlify(rand_bytes(8))
return s
|