136
179
working inventory.
138
181
def __init__(self,
140
if reporter is not None:
141
self.reporter = reporter
143
self.reporter = NullCommitReporter()
184
"""Create a Commit object.
186
:param reporter: the default reporter to use or None to decide later
188
self.reporter = reporter
151
196
specific_files=None,
153
198
allow_pointless=True,
206
message_callback=None,
155
208
"""Commit working copy as a new revision.
157
timestamp -- if not None, seconds-since-epoch for a
158
postdated/predated commit.
160
specific_files -- If true, commit only those files.
162
rev_id -- If set, use this as the new revision id.
210
:param message: the commit message (it or message_callback is required)
212
:param timestamp: if not None, seconds-since-epoch for a
213
postdated/predated commit.
215
:param specific_files: If true, commit only those files.
217
:param rev_id: If set, use this as the new revision id.
163
218
Useful for test or import commands that need to tightly
164
219
control what revisions are assigned. If you duplicate
165
220
a revision id that exists elsewhere it is your own fault.
166
221
If null (default), a time/random revision id is generated.
168
allow_pointless -- If true (default), commit even if nothing
223
:param allow_pointless: If true (default), commit even if nothing
169
224
has changed and no merges are recorded.
226
:param strict: If true, don't allow a commit if the working tree
227
contains unknown files.
229
:param revprops: Properties for new revision
230
:param local: Perform a local only commit.
231
:param reporter: the reporter to use or None for the default
232
:param verbose: if True and the reporter is not None, report everything
233
:param recursive: If set to 'down', commit in any subtrees that have
234
pending changes of any sort during this commit.
171
236
mutter('preparing to commit')
174
self.weave_store = branch.weave_store
176
self.specific_files = specific_files
238
if working_tree is None:
239
raise BzrError("working_tree must be passed into commit().")
241
self.work_tree = working_tree
242
self.branch = self.work_tree.branch
243
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
244
if not self.branch.repository.supports_rich_root():
245
raise errors.RootNotRich()
246
if message_callback is None:
247
if message is not None:
248
if isinstance(message, str):
249
message = message.decode(bzrlib.user_encoding)
250
message_callback = lambda x: message
252
raise BzrError("The message or message_callback keyword"
253
" parameter is required for commit().")
255
self.bound_branch = None
256
self.any_entries_changed = False
257
self.any_entries_deleted = False
259
self.master_branch = None
260
self.master_locked = False
261
self.recursive = recursive
263
if specific_files is not None:
264
self.specific_files = sorted(
265
minimum_path_selection(specific_files))
267
self.specific_files = None
268
self.specific_file_ids = None
177
269
self.allow_pointless = allow_pointless
179
if timestamp is None:
180
self.timestamp = time.time()
182
self.timestamp = long(timestamp)
185
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
189
if committer is None:
190
self.committer = username(self.branch)
192
assert isinstance(committer, basestring), type(committer)
193
self.committer = committer
196
self.timezone = local_time_offset()
198
self.timezone = int(timezone)
200
assert isinstance(message, basestring), type(message)
201
self.message = message
202
self._escape_commit_message()
204
self.branch.lock_write()
270
self.revprops = revprops
271
self.message_callback = message_callback
272
self.timestamp = timestamp
273
self.timezone = timezone
274
self.committer = committer
276
self.verbose = verbose
277
# accumulates an inventory delta to the basis entry, so we can make
278
# just the necessary updates to the workingtree's cached basis.
279
self._basis_delta = []
281
self.work_tree.lock_write()
282
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
283
self.basis_revid = self.work_tree.last_revision()
284
self.basis_tree = self.work_tree.basis_tree()
285
self.basis_tree.lock_read()
206
self.work_tree = self.branch.working_tree()
207
self.work_inv = self.work_tree.inventory
208
self.basis_tree = self.branch.basis_tree()
287
# Cannot commit with conflicts present.
288
if len(self.work_tree.conflicts()) > 0:
289
raise ConflictsInTree
291
# Setup the bound branch variables as needed.
292
self._check_bound_branch()
294
# Check that the working tree is up to date
295
old_revno, new_revno = self._check_out_of_date_tree()
297
# Complete configuration setup
298
if reporter is not None:
299
self.reporter = reporter
300
elif self.reporter is None:
301
self.reporter = self._select_reporter()
302
if self.config is None:
303
self.config = self.branch.get_config()
305
# If provided, ensure the specified files are versioned
306
if self.specific_files is not None:
307
# Note: This routine is being called because it raises
308
# PathNotVersionedError as a side effect of finding the IDs. We
309
# later use the ids we found as input to the working tree
310
# inventory iterator, so we only consider those ids rather than
311
# examining the whole tree again.
312
# XXX: Dont we have filter_unversioned to do this more
314
self.specific_file_ids = tree.find_ids_across_trees(
315
specific_files, [self.basis_tree, self.work_tree])
317
# Setup the progress bar. As the number of files that need to be
318
# committed in unknown, progress is reported as stages.
319
# We keep track of entries separately though and include that
320
# information in the progress bar during the relevant stages.
321
self.pb_stage_name = ""
322
self.pb_stage_count = 0
323
self.pb_stage_total = 5
324
if self.bound_branch:
325
self.pb_stage_total += 1
326
self.pb.show_pct = False
327
self.pb.show_spinner = False
328
self.pb.show_eta = False
329
self.pb.show_count = True
330
self.pb.show_bar = True
332
# After a merge, a selected file commit is not supported.
333
# See 'bzr help merge' for an explanation as to why.
209
334
self.basis_inv = self.basis_tree.inventory
211
335
self._gather_parents()
212
336
if len(self.parents) > 1 and self.specific_files:
213
raise NotImplementedError('selected-file commit of merges is not supported yet')
214
self._check_parents_present()
337
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
339
# Collect the changes
340
self._set_progress_stage("Collecting changes",
341
entries_title="Directory")
342
self.builder = self.branch.get_commit_builder(self.parents,
343
self.config, timestamp, timezone, committer, revprops, rev_id)
216
self._remove_deleted()
217
self._populate_new_inv()
218
self._store_snapshot()
219
self._report_deletes()
221
if not (self.allow_pointless
222
or len(self.parents) > 1
223
or self.new_inv != self.basis_inv):
224
raise PointlessCommit()
226
self._record_inventory()
227
self._record_ancestry()
228
self._make_revision()
229
note('committed r%d {%s}', (self.branch.revno() + 1),
231
self.branch.append_revision(self.rev_id)
232
self.branch.set_pending_merges([])
346
# find the location being committed to
347
if self.bound_branch:
348
master_location = self.master_branch.base
350
master_location = self.branch.base
352
# report the start of the commit
353
self.reporter.started(new_revno, self.rev_id, master_location)
355
self._update_builder_with_changes()
356
self._report_and_accumulate_deletes()
357
self._check_pointless()
359
# TODO: Now the new inventory is known, check for conflicts.
360
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
361
# weave lines, because nothing should be recorded until it is known
362
# that commit will succeed.
363
self._set_progress_stage("Saving data locally")
364
self.builder.finish_inventory()
366
# Prompt the user for a commit message if none provided
367
message = message_callback(self)
368
assert isinstance(message, unicode), type(message)
369
self.message = message
370
self._escape_commit_message()
372
# Add revision data to the local branch
373
self.rev_id = self.builder.commit(self.message)
379
self._process_pre_hooks(old_revno, new_revno)
381
# Upload revision data to the master.
382
# this will propagate merged revisions too if needed.
383
if self.bound_branch:
384
if not self.master_branch.repository.has_same_location(
385
self.branch.repository):
386
self._set_progress_stage("Uploading data to master branch")
387
self.master_branch.repository.fetch(self.branch.repository,
388
revision_id=self.rev_id)
389
# now the master has the revision data
390
# 'commit' to the master first so a timeout here causes the
391
# local branch to be out of date
392
self.master_branch.set_last_revision_info(new_revno,
395
# and now do the commit locally.
396
self.branch.set_last_revision_info(new_revno, self.rev_id)
398
# Make the working tree up to date with the branch
399
self._set_progress_stage("Updating the working tree")
400
self.work_tree.update_basis_by_delta(self.rev_id,
402
self.reporter.completed(new_revno, self.rev_id)
403
self._process_post_hooks(old_revno, new_revno)
236
def _record_inventory(self):
237
"""Store the inventory for the new revision."""
238
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
239
self.inv_sha1 = sha_string(inv_text)
240
s = self.branch.control_weaves
241
s.add_text('inventory', self.rev_id,
242
split_lines(inv_text), self.present_parents)
408
def _select_reporter(self):
409
"""Select the CommitReporter to use."""
411
return NullCommitReporter()
412
return ReportCommitToLog()
414
def _check_pointless(self):
415
if self.allow_pointless:
417
# A merge with no effect on files
418
if len(self.parents) > 1:
420
# TODO: we could simplify this by using self._basis_delta.
422
# The initial commit adds a root directory, but this in itself is not
423
# a worthwhile commit.
424
if (self.basis_revid == revision.NULL_REVISION and
425
len(self.builder.new_inventory) == 1):
426
raise PointlessCommit()
427
# If length == 1, then we only have the root entry. Which means
428
# that there is no real difference (only the root could be different)
429
# unless deletes occured, in which case the length is irrelevant.
430
if (self.any_entries_deleted or
431
(len(self.builder.new_inventory) != 1 and
432
self.any_entries_changed)):
434
raise PointlessCommit()
436
def _check_bound_branch(self):
437
"""Check to see if the local branch is bound.
439
If it is bound, then most of the commit will actually be
440
done using the remote branch as the target branch.
441
Only at the end will the local branch be updated.
443
if self.local and not self.branch.get_bound_location():
444
raise errors.LocalRequiresBoundBranch()
447
self.master_branch = self.branch.get_master_branch()
449
if not self.master_branch:
450
# make this branch the reference branch for out of date checks.
451
self.master_branch = self.branch
454
# If the master branch is bound, we must fail
455
master_bound_location = self.master_branch.get_bound_location()
456
if master_bound_location:
457
raise errors.CommitToDoubleBoundBranch(self.branch,
458
self.master_branch, master_bound_location)
460
# TODO: jam 20051230 We could automatically push local
461
# commits to the remote branch if they would fit.
462
# But for now, just require remote to be identical
465
# Make sure the local branch is identical to the master
466
master_info = self.master_branch.last_revision_info()
467
local_info = self.branch.last_revision_info()
468
if local_info != master_info:
469
raise errors.BoundBranchOutOfDate(self.branch,
472
# Now things are ready to change the master branch
474
self.bound_branch = self.branch
475
self.master_branch.lock_write()
476
self.master_locked = True
478
def _check_out_of_date_tree(self):
479
"""Check that the working tree is up to date.
481
:return: old_revision_number,new_revision_number tuple
484
first_tree_parent = self.work_tree.get_parent_ids()[0]
486
# if there are no parents, treat our parent as 'None'
487
# this is so that we still consider the master branch
488
# - in a checkout scenario the tree may have no
489
# parents but the branch may do.
490
first_tree_parent = bzrlib.revision.NULL_REVISION
491
old_revno, master_last = self.master_branch.last_revision_info()
492
if master_last != first_tree_parent:
493
if master_last != bzrlib.revision.NULL_REVISION:
494
raise errors.OutOfDateTree(self.work_tree)
495
if self.branch.repository.has_revision(first_tree_parent):
496
new_revno = old_revno + 1
498
# ghost parents never appear in revision history.
500
return old_revno,new_revno
502
def _process_pre_hooks(self, old_revno, new_revno):
503
"""Process any registered pre commit hooks."""
504
self._set_progress_stage("Running pre_commit hooks")
505
self._process_hooks("pre_commit", old_revno, new_revno)
507
def _process_post_hooks(self, old_revno, new_revno):
508
"""Process any registered post commit hooks."""
509
# Process the post commit hooks, if any
510
self._set_progress_stage("Running post_commit hooks")
511
# old style commit hooks - should be deprecated ? (obsoleted in
513
if self.config.post_commit() is not None:
514
hooks = self.config.post_commit().split(' ')
515
# this would be nicer with twisted.python.reflect.namedAny
517
result = eval(hook + '(branch, rev_id)',
518
{'branch':self.branch,
520
'rev_id':self.rev_id})
521
# process new style post commit hooks
522
self._process_hooks("post_commit", old_revno, new_revno)
524
def _process_hooks(self, hook_name, old_revno, new_revno):
525
if not Branch.hooks[hook_name]:
528
# new style commit hooks:
529
if not self.bound_branch:
530
hook_master = self.branch
533
hook_master = self.master_branch
534
hook_local = self.branch
535
# With bound branches, when the master is behind the local branch,
536
# the 'old_revno' and old_revid values here are incorrect.
537
# XXX: FIXME ^. RBC 20060206
539
old_revid = self.parents[0]
541
old_revid = bzrlib.revision.NULL_REVISION
543
if hook_name == "pre_commit":
544
future_tree = self.builder.revision_tree()
545
tree_delta = future_tree.changes_from(self.basis_tree,
548
for hook in Branch.hooks[hook_name]:
549
# show the running hook in the progress bar. As hooks may
550
# end up doing nothing (e.g. because they are not configured by
551
# the user) this is still showing progress, not showing overall
552
# actions - its up to each plugin to show a UI if it want's to
553
# (such as 'Emailing diff to foo@example.com').
554
self.pb_stage_name = "Running %s hooks [%s]" % \
555
(hook_name, Branch.hooks.get_hook_name(hook))
556
self._emit_progress()
557
if 'hooks' in debug.debug_flags:
558
mutter("Invoking commit hook: %r", hook)
559
if hook_name == "post_commit":
560
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
562
elif hook_name == "pre_commit":
563
hook(hook_local, hook_master,
564
old_revno, old_revid, new_revno, self.rev_id,
565
tree_delta, future_tree)
568
"""Cleanup any open locks, progress bars etc."""
569
cleanups = [self._cleanup_bound_branch,
570
self.basis_tree.unlock,
571
self.work_tree.unlock,
573
found_exception = None
574
for cleanup in cleanups:
577
# we want every cleanup to run no matter what.
578
# so we have a catchall here, but we will raise the
579
# last encountered exception up the stack: and
580
# typically this will be useful enough.
583
if found_exception is not None:
584
# don't do a plan raise, because the last exception may have been
585
# trashed, e is our sure-to-work exception even though it loses the
586
# full traceback. XXX: RBC 20060421 perhaps we could check the
587
# exc_info and if its the same one do a plain raise otherwise
588
# 'raise e' as we do now.
591
def _cleanup_bound_branch(self):
592
"""Executed at the end of a try/finally to cleanup a bound branch.
594
If the branch wasn't bound, this is a no-op.
595
If it was, it resents self.branch to the local branch, instead
598
if not self.bound_branch:
600
if self.master_locked:
601
self.master_branch.unlock()
244
603
def _escape_commit_message(self):
245
604
"""Replace xml-incompatible control characters."""
605
# FIXME: RBC 20060419 this should be done by the revision
606
# serialiser not by commit. Then we can also add an unescaper
607
# in the deserializer and start roundtripping revision messages
608
# precisely. See repository_implementations/test_repository.py
246
610
# Python strings can include characters that can't be
247
611
# represented in well-formed XML; escape characters that
248
612
# aren't listed in the XML specification
249
613
# (http://www.w3.org/TR/REC-xml/#NT-Char).
250
if isinstance(self.message, unicode):
251
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
253
# Use a regular 'str' as pattern to avoid having re.subn
254
# return 'unicode' results.
255
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
256
614
self.message, escape_count = re.subn(
615
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
258
616
lambda match: match.group(0).encode('unicode_escape'),
261
note("replaced %d control characters in message", escape_count)
263
def _record_ancestry(self):
264
"""Append merged revision ancestry to the ancestry file.
266
This should be the merged ancestry of all parents, plus the
268
s = self.branch.control_weaves
269
w = s.get_weave_or_empty('ancestry')
270
lines = self._make_ancestry(w)
271
w.add(self.rev_id, self.present_parents, lines)
272
s.put_weave('ancestry', w)
274
def _make_ancestry(self, ancestry_weave):
275
"""Return merged ancestry lines.
277
The lines are revision-ids followed by newlines."""
278
parent_ancestries = [ancestry_weave.get(p) for p in self.present_parents]
279
new_lines = merge_ancestry_lines(self.rev_id, parent_ancestries)
280
mutter('merged ancestry of {%s}:\n%s', self.rev_id, ''.join(new_lines))
619
self.reporter.escaped(escape_count, self.message)
283
621
def _gather_parents(self):
284
622
"""Record the parents of a merge for merge detection."""
285
pending_merges = self.branch.pending_merges()
287
self.parent_trees = []
288
self.present_parents = []
289
precursor_id = self.branch.last_revision()
291
self.parents.append(precursor_id)
292
self.parents += pending_merges
293
for revision in self.parents:
294
if self.branch.has_revision(revision):
295
self.parent_trees.append(self.branch.revision_tree(revision))
296
self.present_parents.append(revision)
298
def _check_parents_present(self):
299
for parent_id in self.parents:
300
mutter('commit parent revision {%s}', parent_id)
301
if not self.branch.has_revision(parent_id):
302
if parent_id == self.branch.last_revision():
303
warning("parent is pissing %r", parent_id)
304
raise HistoryMissing(self.branch, 'revision', parent_id)
306
mutter("commit will ghost revision %r", parent_id)
308
def _make_revision(self):
309
"""Record a new revision object for this commit."""
310
self.rev = Revision(timestamp=self.timestamp,
311
timezone=self.timezone,
312
committer=self.committer,
313
message=self.message,
314
inventory_sha1=self.inv_sha1,
315
revision_id=self.rev_id)
316
self.rev.parent_ids = self.parents
318
serializer_v5.write_revision(self.rev, rev_tmp)
320
self.branch.revision_store.add(rev_tmp, self.rev_id)
321
mutter('new revision_id is {%s}', self.rev_id)
324
def _remove_deleted(self):
325
"""Remove deleted files from the working inventories.
327
This is done prior to taking the working inventory as the
328
basis for the new committed inventory.
330
This returns true if any files
331
*that existed in the basis inventory* were deleted.
332
Files that were added and deleted
333
in the working copy don't matter.
623
# TODO: Make sure that this list doesn't contain duplicate
624
# entries and the order is preserved when doing this.
625
self.parents = self.work_tree.get_parent_ids()
626
self.parent_invs = [self.basis_inv]
627
for revision in self.parents[1:]:
628
if self.branch.repository.has_revision(revision):
629
mutter('commit parent revision {%s}', revision)
630
inventory = self.branch.repository.get_inventory(revision)
631
self.parent_invs.append(inventory)
633
mutter('commit parent ghost revision {%s}', revision)
635
def _update_builder_with_changes(self):
636
"""Update the commit builder with the data about what has changed.
335
specific = self.specific_files
638
# Build the revision inventory.
640
# This starts by creating a new empty inventory. Depending on
641
# which files are selected for commit, and what is present in the
642
# current tree, the new inventory is populated. inventory entries
643
# which are candidates for modification have their revision set to
644
# None; inventory entries that are carried over untouched have their
645
# revision set to their prior value.
647
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
648
# results to create a new inventory at the same time, which results
649
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
652
specific_files = self.specific_files
653
mutter("Selecting files for commit with filter %s", specific_files)
655
# Build the new inventory
656
self._populate_from_inventory(specific_files)
658
# If specific files are selected, then all un-selected files must be
659
# recorded in their previous state. For more details, see
660
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
662
for path, old_ie in self.basis_inv.iter_entries():
663
if old_ie.file_id in self.builder.new_inventory:
664
# already added - skip.
666
if is_inside_any(specific_files, path):
667
# was inside the selected path, if not present it has been
670
if old_ie.kind == 'directory':
671
self._next_progress_entry()
672
# not in final inv yet, was not in the selected files, so is an
673
# entry to be preserved unaltered.
675
# Note: specific file commits after a merge are currently
676
# prohibited. This test is for sanity/safety in case it's
677
# required after that changes.
678
if len(self.parents) > 1:
680
delta, version_recorded = self.builder.record_entry_contents(
681
ie, self.parent_invs, path, self.basis_tree, None)
683
self.any_entries_changed = True
684
if delta: self._basis_delta.append(delta)
686
def _report_and_accumulate_deletes(self):
687
# XXX: Could the list of deleted paths and ids be instead taken from
688
# _populate_from_inventory?
689
deleted_ids = set(self.basis_inv._byid.keys()) - \
690
set(self.builder.new_inventory._byid.keys())
692
self.any_entries_deleted = True
693
deleted = [(self.basis_tree.id2path(file_id), file_id)
694
for file_id in deleted_ids]
696
# XXX: this is not quite directory-order sorting
697
for path, file_id in deleted:
698
self._basis_delta.append((path, None, file_id, None))
699
self.reporter.deleted(path)
701
def _populate_from_inventory(self, specific_files):
702
"""Populate the CommitBuilder by walking the working tree inventory."""
704
# raise an exception as soon as we find a single unknown.
705
for unknown in self.work_tree.unknowns():
706
raise StrictCommitFailed()
708
report_changes = self.reporter.is_verbose()
337
for path, ie in self.work_inv.iter_entries():
338
if specific and not is_inside_any(specific, path):
340
if not self.work_tree.has_filename(path):
341
note('missing %s', path)
342
deleted_ids.append(ie.file_id)
344
for file_id in deleted_ids:
345
if file_id in self.work_inv:
346
del self.work_inv[file_id]
347
self.branch._write_inventory(self.work_inv)
350
def _find_entry_parents(self, file_id):
351
"""Return the text versions and hashes for all file parents.
353
Returned as a map from text version to inventory entry.
355
This is a set containing the file versions in all parents
356
revisions containing the file. If the file is new, the set
359
for tree in self.parent_trees:
360
if file_id in tree.inventory:
361
ie = tree.inventory[file_id]
362
assert ie.file_id == file_id
364
assert r[ie.revision] == ie
369
def _store_snapshot(self):
370
"""Pass over inventory and record a snapshot.
372
Entries get a new revision when they are modified in
373
any way, which includes a merge with a new set of
374
parents that have the same entry. Currently we do not
375
check for that set being ancestors of each other - and
376
we should - only parallel children should count for this
377
test see find_entry_parents to correct this. FIXME <---
378
I.e. if we are merging in revision FOO, and our
379
copy of file id BAR is identical to FOO.BAR, we should
380
generate a new revision of BAR IF and only IF FOO is
381
neither a child of our current tip, nor an ancestor of
382
our tip. The presence of FOO in our store should not
383
affect this logic UNLESS we are doing a merge of FOO,
386
# XXX: Need to think more here about when the user has
387
# made a specific decision on a particular value -- c.f.
389
for path, ie in self.new_inv.iter_entries():
390
previous_entries = self._find_entry_parents(ie. file_id)
391
if ie.revision is None:
392
change = ie.snapshot(self.rev_id, path, previous_entries,
393
self.work_tree, self.weave_store)
396
note("%s %s", change, path)
398
def _populate_new_inv(self):
399
"""Build revision inventory.
401
This creates a new empty inventory. Depending on
402
which files are selected for commit, and what is present in the
403
current tree, the new inventory is populated. inventory entries
404
which are candidates for modification have their revision set to
405
None; inventory entries that are carried over untouched have their
406
revision set to their prior value.
408
mutter("Selecting files for commit with filter %s", self.specific_files)
409
self.new_inv = Inventory()
410
for path, new_ie in self.work_inv.iter_entries():
411
file_id = new_ie.file_id
412
mutter('check %s {%s}', path, new_ie.file_id)
413
if self.specific_files:
414
if not is_inside_any(self.specific_files, path):
415
mutter('%s not selected for commit', path)
416
self._carry_file(file_id)
418
mutter('%s selected for commit', path)
710
# A tree of paths that have been deleted. E.g. if foo/bar has been
711
# deleted, then we have {'foo':{'bar':{}}}
713
# XXX: Note that entries may have the wrong kind because the entry does
714
# not reflect the status on disk.
715
work_inv = self.work_tree.inventory
716
entries = work_inv.iter_entries_by_dir(
717
specific_file_ids=self.specific_file_ids, yield_parents=True)
718
for path, existing_ie in entries:
719
file_id = existing_ie.file_id
720
name = existing_ie.name
721
parent_id = existing_ie.parent_id
722
kind = existing_ie.kind
723
if kind == 'directory':
724
self._next_progress_entry()
725
# Skip files that have been deleted from the working tree.
726
# The deleted path ids are also recorded so they can be explicitly
729
path_segments = splitpath(path)
730
deleted_dict = deleted_paths
731
for segment in path_segments:
732
deleted_dict = deleted_dict.get(segment, None)
734
# We either took a path not present in the dict
735
# (deleted_dict was None), or we've reached an empty
736
# child dir in the dict, so are now a sub-path.
740
if deleted_dict is not None:
741
# the path has a deleted parent, do not add it.
743
content_summary = self.work_tree.path_content_summary(path)
744
# Note that when a filter of specific files is given, we must only
745
# skip/record deleted files matching that filter.
746
if not specific_files or is_inside_any(specific_files, path):
747
if content_summary[0] == 'missing':
748
if not deleted_paths:
749
# path won't have been split yet.
750
path_segments = splitpath(path)
751
deleted_dict = deleted_paths
752
for segment in path_segments:
753
deleted_dict = deleted_dict.setdefault(segment, {})
754
self.reporter.missing(path)
755
deleted_ids.append(file_id)
757
# TODO: have the builder do the nested commit just-in-time IF and
759
if content_summary[0] == 'tree-reference':
760
# enforce repository nested tree policy.
761
if (not self.work_tree.supports_tree_reference() or
762
# repository does not support it either.
763
not self.branch.repository._format.supports_tree_reference):
764
content_summary = ('directory',) + content_summary[1:]
765
kind = content_summary[0]
766
# TODO: specific_files filtering before nested tree processing
767
if kind == 'tree-reference':
768
if self.recursive == 'down':
769
nested_revision_id = self._commit_nested_tree(
771
content_summary = content_summary[:3] + (
774
content_summary = content_summary[:3] + (
775
self.work_tree.get_reference_revision(file_id),)
777
# Record an entry for this item
778
# Note: I don't particularly want to have the existing_ie
779
# parameter but the test suite currently (28-Jun-07) breaks
780
# without it thanks to a unicode normalisation issue. :-(
781
definitely_changed = kind != existing_ie.kind
782
self._record_entry(path, file_id, specific_files, kind, name,
783
parent_id, definitely_changed, existing_ie, report_changes,
786
# Unversion IDs that were found to be deleted
787
self.work_tree.unversion(deleted_ids)
789
def _commit_nested_tree(self, file_id, path):
790
"Commit a nested tree."
791
sub_tree = self.work_tree.get_nested_tree(file_id, path)
792
# FIXME: be more comprehensive here:
793
# this works when both trees are in --trees repository,
794
# but when both are bound to a different repository,
795
# it fails; a better way of approaching this is to
796
# finally implement the explicit-caches approach design
797
# a while back - RBC 20070306.
798
if sub_tree.branch.repository.has_same_location(
799
self.work_tree.branch.repository):
800
sub_tree.branch.repository = \
801
self.work_tree.branch.repository
803
return sub_tree.commit(message=None, revprops=self.revprops,
804
recursive=self.recursive,
805
message_callback=self.message_callback,
806
timestamp=self.timestamp, timezone=self.timezone,
807
committer=self.committer,
808
allow_pointless=self.allow_pointless,
809
strict=self.strict, verbose=self.verbose,
810
local=self.local, reporter=self.reporter)
811
except errors.PointlessCommit:
812
return self.work_tree.get_reference_revision(file_id)
814
def _record_entry(self, path, file_id, specific_files, kind, name,
815
parent_id, definitely_changed, existing_ie, report_changes,
817
"Record the new inventory entry for a path if any."
818
# mutter('check %s {%s}', path, file_id)
819
# mutter('%s selected for commit', path)
820
if definitely_changed or existing_ie is None:
821
ie = make_entry(kind, name, parent_id, file_id)
823
ie = existing_ie.copy()
420
824
ie.revision = None
423
def _carry_file(self, file_id):
424
"""Carry the file unchanged from the basis revision."""
425
if self.basis_inv.has_id(file_id):
426
self.new_inv.add(self.basis_inv[file_id].copy())
428
def _report_deletes(self):
429
for file_id in self.basis_inv:
430
if file_id not in self.new_inv:
431
note('deleted %s', self.basis_inv.id2path(file_id))
435
def _gen_revision_id(branch, when):
436
"""Return new revision-id."""
437
s = '%s-%s-' % (user_email(branch), compact_date(when))
438
s += hexlify(rand_bytes(8))
444
def merge_ancestry_lines(rev_id, ancestries):
445
"""Return merged ancestry lines.
447
rev_id -- id of the new revision
449
ancestries -- a sequence of ancestries for parent revisions,
450
as newline-terminated line lists.
452
if len(ancestries) == 0:
453
return [rev_id + '\n']
454
seen = set(ancestries[0])
455
ancs = ancestries[0][:]
456
for parent_ancestry in ancestries[1:]:
457
for line in parent_ancestry:
458
assert line[-1] == '\n'
825
delta, version_recorded = self.builder.record_entry_contents(ie,
826
self.parent_invs, path, self.work_tree, content_summary)
828
self._basis_delta.append(delta)
830
self.any_entries_changed = True
832
self._report_change(ie, path)
835
def _report_change(self, ie, path):
836
"""Report a change to the user.
838
The change that has occurred is described relative to the basis
841
if (self.basis_inv.has_id(ie.file_id)):
842
basis_ie = self.basis_inv[ie.file_id]
845
change = ie.describe_change(basis_ie, ie)
846
if change in (InventoryEntry.RENAMED,
847
InventoryEntry.MODIFIED_AND_RENAMED):
848
old_path = self.basis_inv.id2path(ie.file_id)
849
self.reporter.renamed(change, old_path, path)
851
self.reporter.snapshot_change(change, path)
853
def _set_progress_stage(self, name, entries_title=None):
854
"""Set the progress stage and emit an update to the progress bar."""
855
self.pb_stage_name = name
856
self.pb_stage_count += 1
857
self.pb_entries_title = entries_title
858
if entries_title is not None:
859
self.pb_entries_count = 0
860
self.pb_entries_total = '?'
861
self._emit_progress()
863
def _next_progress_entry(self):
864
"""Emit an update to the progress bar and increment the entry count."""
865
self.pb_entries_count += 1
866
self._emit_progress()
868
def _emit_progress(self):
869
if self.pb_entries_title:
870
if self.pb_entries_total == '?':
871
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
872
self.pb_entries_title, self.pb_entries_count)
874
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
875
self.pb_entries_title, self.pb_entries_count,
876
str(self.pb_entries_total))
878
text = "%s - Stage" % (self.pb_stage_name)
879
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
