1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
def commit(branch, message, timestamp=None, timezone=None,
22
"""Commit working copy as a new revision.
24
The basic approach is to add all the file texts into the
25
store, then the inventory, then make a new revision pointing
26
to that inventory and store that.
28
This is not quite safe if the working copy changes during the
29
commit; for the moment that is simply not allowed. A better
30
approach is to make a temporary copy of the files before
31
computing their hashes, and then add those hashes in turn to
32
the inventory. This should mean at least that there are no
33
broken hash pointers. There is no way we can get a snapshot
34
of the whole directory at an instant. This would also have to
35
be robust against files disappearing, moving, etc. So the
36
whole thing is a bit hard.
38
timestamp -- if not None, seconds-since-epoch for a
39
postdated/predated commit.
18
# The newly committed revision is going to have a shape corresponding
19
# to that of the working tree. Files that are not in the
20
# working tree and that were in the predecessor are reported as
21
# removed --- this can include files that were either removed from the
22
# inventory or deleted in the working tree. If they were only
23
# deleted from disk, they are removed from the working inventory.
25
# We then consider the remaining entries, which will be in the new
26
# version. Directory entries are simply copied across. File entries
27
# must be checked to see if a new version of the file should be
28
# recorded. For each parent revision tree, we check to see what
29
# version of the file was present. If the file was present in at
30
# least one tree, and if it was the same version in all the trees,
31
# then we can just refer to that version. Otherwise, a new version
32
# representing the merger of the file versions must be added.
34
# TODO: Update hashcache before and after - or does the WorkingTree
37
# TODO: Rather than mashing together the ancestry and storing it back,
38
# perhaps the weave should have single method which does it all in one
39
# go, avoiding a lot of redundant work.
41
# TODO: Perhaps give a warning if one of the revisions marked as
42
# merged is already in the ancestry, and then don't record it as a
45
# TODO: If the file is newly merged but unchanged from the version it
46
# merges from, then it should still be reported as newly added
47
# relative to the basis revision.
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
# the rest of the code; add a deprecation of the old name.
57
from cStringIO import StringIO
65
from bzrlib.branch import Branch
67
from bzrlib.errors import (BzrError, PointlessCommit,
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
72
is_inside_or_parent_of_any,
73
minimum_path_selection,
74
quotefn, sha_file, split_lines)
75
from bzrlib.testament import Testament
76
from bzrlib.trace import mutter, note, warning, is_quiet
77
from bzrlib.xml5 import serializer_v5
78
from bzrlib.inventory import InventoryEntry, make_entry
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (deprecated_passed,
83
from bzrlib.workingtree import WorkingTree
84
from bzrlib.urlutils import unescape_for_display
88
class NullCommitReporter(object):
89
"""I report on progress of a commit."""
91
def started(self, revno, revid, location=None):
94
def snapshot_change(self, change, path):
97
def completed(self, revno, rev_id):
100
def deleted(self, file_id):
103
def escaped(self, escape_count, message):
106
def missing(self, path):
109
def renamed(self, change, old_path, new_path):
112
def is_verbose(self):
116
class ReportCommitToLog(NullCommitReporter):
118
def _note(self, format, *args):
121
Subclasses may choose to override this method.
125
def snapshot_change(self, change, path):
126
if change == 'unchanged':
128
if change == 'added' and path == '':
130
self._note("%s %s", change, path)
132
def started(self, revno, rev_id, location=None):
133
if location is not None:
134
location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
137
self._note('Committing revision %d%s.', revno, location)
139
def completed(self, revno, rev_id):
140
self._note('Committed revision %d.', revno)
142
def deleted(self, file_id):
143
self._note('deleted %s', file_id)
145
def escaped(self, escape_count, message):
146
self._note("replaced %d control characters in message", escape_count)
148
def missing(self, path):
149
self._note('missing %s', path)
151
def renamed(self, change, old_path, new_path):
152
self._note('%s %s => %s', change, old_path, new_path)
154
def is_verbose(self):
158
class Commit(object):
159
"""Task of committing a new revision.
161
This is a MethodObject: it accumulates state as the commit is
162
prepared, and then it is discarded. It doesn't represent
163
historical revisions, just the act of recording a new one.
166
Modified to hold a list of files that have been deleted from
167
the working directory; these should be removed from the
42
import os, time, tempfile
44
from inventory import Inventory
45
from osutils import isdir, isfile, sha_string, quotefn, \
46
local_time_offset, username
48
from branch import gen_file_id
49
from errors import BzrError
50
from revision import Revision
51
from textui import show_status
52
from trace import mutter, note
54
branch._need_writelock()
56
## TODO: Show branch names
58
# TODO: Don't commit if there are no changes, unless forced?
60
# First walk over the working inventory; and both update that
61
# and also build a new revision inventory. The revision
62
# inventory needs to hold the text-id, sha1 and size of the
63
# actual file versions committed in the revision. (These are
64
# not present in the working inventory.) We also need to
65
# detect missing/deleted files, and remove them from the
68
work_inv = branch.read_working_inventory()
70
basis = branch.basis_tree()
71
basis_inv = basis.inventory
73
for path, entry in work_inv.iter_entries():
74
## TODO: Cope with files that have gone missing.
76
## TODO: Check that the file kind has not changed from the previous
77
## revision of this file (if any).
81
p = branch.abspath(path)
82
file_id = entry.file_id
83
mutter('commit prep file %s, id %r ' % (p, file_id))
85
if not os.path.exists(p):
86
mutter(" file is missing, removing from inventory")
88
show_status('D', entry.kind, quotefn(path))
89
missing_ids.append(file_id)
92
# TODO: Handle files that have been deleted
94
# TODO: Maybe a special case for empty files? Seems a
95
# waste to store them many times.
99
if basis_inv.has_id(file_id):
100
old_kind = basis_inv[file_id].kind
101
if old_kind != entry.kind:
102
raise BzrError("entry %r changed kind from %r to %r"
103
% (file_id, old_kind, entry.kind))
105
if entry.kind == 'directory':
107
raise BzrError("%s is entered as directory but not a directory" % quotefn(p))
108
elif entry.kind == 'file':
110
raise BzrError("%s is entered as file but is not a file" % quotefn(p))
112
content = file(p, 'rb').read()
114
entry.text_sha1 = sha_string(content)
115
entry.text_size = len(content)
117
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
119
and (old_ie.text_size == entry.text_size)
120
and (old_ie.text_sha1 == entry.text_sha1)):
121
## assert content == basis.get_file(file_id).read()
122
entry.text_id = basis_inv[file_id].text_id
123
mutter(' unchanged from previous text_id {%s}' %
127
entry.text_id = gen_file_id(entry.name)
128
branch.text_store.add(content, entry.text_id)
129
mutter(' stored with text_id {%s}' % entry.text_id)
133
elif (old_ie.name == entry.name
134
and old_ie.parent_id == entry.parent_id):
139
show_status(state, entry.kind, quotefn(path))
141
for file_id in missing_ids:
142
# have to do this later so we don't mess up the iterator.
143
# since parents may be removed before their children we
146
# FIXME: There's probably a better way to do this; perhaps
147
# the workingtree should know how to filter itbranch.
148
if work_inv.has_id(file_id):
149
del work_inv[file_id]
152
inv_id = rev_id = _gen_revision_id(time.time())
154
inv_tmp = tempfile.TemporaryFile()
155
inv.write_xml(inv_tmp)
157
branch.inventory_store.add(inv_tmp, inv_id)
158
mutter('new inventory_id is {%s}' % inv_id)
160
branch._write_inventory(work_inv)
162
if timestamp == None:
163
timestamp = time.time()
165
if committer == None:
166
committer = username()
169
timezone = local_time_offset()
171
mutter("building commit log message")
172
rev = Revision(timestamp=timestamp,
175
precursor = branch.last_patch(),
180
rev_tmp = tempfile.TemporaryFile()
181
rev.write_xml(rev_tmp)
183
branch.revision_store.add(rev_tmp, rev_id)
184
mutter("new revision_id is {%s}" % rev_id)
186
## XXX: Everything up to here can simply be orphaned if we abort
187
## the commit; it will leave junk files behind but that doesn't
190
## TODO: Read back the just-generated changeset, and make sure it
191
## applies and recreates the right state.
193
## TODO: Also calculate and store the inventory SHA1
194
mutter("committing patch r%d" % (branch.revno() + 1))
197
branch.append_revision(rev_id)
200
note("commited r%d" % branch.revno())
204
def _gen_revision_id(when):
205
"""Return new revision-id."""
206
from binascii import hexlify
207
from osutils import rand_bytes, compact_date, user_email
209
s = '%s-%s-' % (user_email(), compact_date(when))
210
s += hexlify(rand_bytes(8))
173
"""Create a Commit object.
175
:param reporter: the default reporter to use or None to decide later
177
self.reporter = reporter
187
allow_pointless=True,
195
message_callback=None,
197
"""Commit working copy as a new revision.
199
:param message: the commit message (it or message_callback is required)
201
:param timestamp: if not None, seconds-since-epoch for a
202
postdated/predated commit.
204
:param specific_files: If true, commit only those files.
206
:param rev_id: If set, use this as the new revision id.
207
Useful for test or import commands that need to tightly
208
control what revisions are assigned. If you duplicate
209
a revision id that exists elsewhere it is your own fault.
210
If null (default), a time/random revision id is generated.
212
:param allow_pointless: If true (default), commit even if nothing
213
has changed and no merges are recorded.
215
:param strict: If true, don't allow a commit if the working tree
216
contains unknown files.
218
:param revprops: Properties for new revision
219
:param local: Perform a local only commit.
220
:param reporter: the reporter to use or None for the default
221
:param verbose: if True and the reporter is not None, report everything
222
:param recursive: If set to 'down', commit in any subtrees that have
223
pending changes of any sort during this commit.
225
mutter('preparing to commit')
227
if working_tree is None:
228
raise BzrError("working_tree must be passed into commit().")
230
self.work_tree = working_tree
231
self.branch = self.work_tree.branch
232
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
233
if not self.branch.repository.supports_rich_root():
234
raise errors.RootNotRich()
235
if message_callback is None:
236
if message is not None:
237
if isinstance(message, str):
238
message = message.decode(bzrlib.user_encoding)
239
message_callback = lambda x: message
241
raise BzrError("The message or message_callback keyword"
242
" parameter is required for commit().")
244
self.bound_branch = None
245
self.any_entries_changed = False
246
self.any_entries_deleted = False
248
self.master_branch = None
249
self.master_locked = False
250
self.recursive = recursive
252
if specific_files is not None:
253
self.specific_files = sorted(
254
minimum_path_selection(specific_files))
256
self.specific_files = None
257
self.specific_file_ids = None
258
self.allow_pointless = allow_pointless
259
self.revprops = revprops
260
self.message_callback = message_callback
261
self.timestamp = timestamp
262
self.timezone = timezone
263
self.committer = committer
265
self.verbose = verbose
266
# accumulates an inventory delta to the basis entry, so we can make
267
# just the necessary updates to the workingtree's cached basis.
268
self._basis_delta = []
270
self.work_tree.lock_write()
271
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
272
self.basis_revid = self.work_tree.last_revision()
273
self.basis_tree = self.work_tree.basis_tree()
274
self.basis_tree.lock_read()
276
# Cannot commit with conflicts present.
277
if len(self.work_tree.conflicts()) > 0:
278
raise ConflictsInTree
280
# Setup the bound branch variables as needed.
281
self._check_bound_branch()
283
# Check that the working tree is up to date
284
old_revno, new_revno = self._check_out_of_date_tree()
286
# Complete configuration setup
287
if reporter is not None:
288
self.reporter = reporter
289
elif self.reporter is None:
290
self.reporter = self._select_reporter()
291
if self.config is None:
292
self.config = self.branch.get_config()
294
# If provided, ensure the specified files are versioned
295
if self.specific_files is not None:
296
# Note: This routine is being called because it raises
297
# PathNotVersionedError as a side effect of finding the IDs. We
298
# later use the ids we found as input to the working tree
299
# inventory iterator, so we only consider those ids rather than
300
# examining the whole tree again.
301
# XXX: Dont we have filter_unversioned to do this more
303
self.specific_file_ids = tree.find_ids_across_trees(
304
specific_files, [self.basis_tree, self.work_tree])
306
# Setup the progress bar. As the number of files that need to be
307
# committed in unknown, progress is reported as stages.
308
# We keep track of entries separately though and include that
309
# information in the progress bar during the relevant stages.
310
self.pb_stage_name = ""
311
self.pb_stage_count = 0
312
self.pb_stage_total = 5
313
if self.bound_branch:
314
self.pb_stage_total += 1
315
self.pb.show_pct = False
316
self.pb.show_spinner = False
317
self.pb.show_eta = False
318
self.pb.show_count = True
319
self.pb.show_bar = True
321
# After a merge, a selected file commit is not supported.
322
# See 'bzr help merge' for an explanation as to why.
323
self.basis_inv = self.basis_tree.inventory
324
self._gather_parents()
325
if len(self.parents) > 1 and self.specific_files:
326
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
328
# Collect the changes
329
self._set_progress_stage("Collecting changes",
330
entries_title="Directory")
331
self.builder = self.branch.get_commit_builder(self.parents,
332
self.config, timestamp, timezone, committer, revprops, rev_id)
335
# find the location being committed to
336
if self.bound_branch:
337
master_location = self.master_branch.base
339
master_location = self.branch.base
341
# report the start of the commit
342
self.reporter.started(new_revno, self.rev_id, master_location)
344
self._update_builder_with_changes()
345
self._report_and_accumulate_deletes()
346
self._check_pointless()
348
# TODO: Now the new inventory is known, check for conflicts.
349
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
350
# weave lines, because nothing should be recorded until it is known
351
# that commit will succeed.
352
self._set_progress_stage("Saving data locally")
353
self.builder.finish_inventory()
355
# Prompt the user for a commit message if none provided
356
message = message_callback(self)
357
assert isinstance(message, unicode), type(message)
358
self.message = message
359
self._escape_commit_message()
361
# Add revision data to the local branch
362
self.rev_id = self.builder.commit(self.message)
368
self._process_pre_hooks(old_revno, new_revno)
370
# Upload revision data to the master.
371
# this will propagate merged revisions too if needed.
372
if self.bound_branch:
373
self._set_progress_stage("Uploading data to master branch")
374
self.master_branch.repository.fetch(self.branch.repository,
375
revision_id=self.rev_id)
376
# now the master has the revision data
377
# 'commit' to the master first so a timeout here causes the
378
# local branch to be out of date
379
self.master_branch.set_last_revision_info(new_revno,
382
# and now do the commit locally.
383
self.branch.set_last_revision_info(new_revno, self.rev_id)
385
# Make the working tree up to date with the branch
386
self._set_progress_stage("Updating the working tree")
387
self.work_tree.update_basis_by_delta(self.rev_id,
389
self.reporter.completed(new_revno, self.rev_id)
390
self._process_post_hooks(old_revno, new_revno)
395
def _select_reporter(self):
396
"""Select the CommitReporter to use."""
398
return NullCommitReporter()
399
return ReportCommitToLog()
401
def _check_pointless(self):
402
if self.allow_pointless:
404
# A merge with no effect on files
405
if len(self.parents) > 1:
407
# TODO: we could simplify this by using self._basis_delta.
409
# The initial commit adds a root directory, but this in itself is not
410
# a worthwhile commit.
411
if (self.basis_revid == revision.NULL_REVISION and
412
len(self.builder.new_inventory) == 1):
413
raise PointlessCommit()
414
# If length == 1, then we only have the root entry. Which means
415
# that there is no real difference (only the root could be different)
416
# unless deletes occured, in which case the length is irrelevant.
417
if (self.any_entries_deleted or
418
(len(self.builder.new_inventory) != 1 and
419
self.any_entries_changed)):
421
raise PointlessCommit()
423
def _check_bound_branch(self):
424
"""Check to see if the local branch is bound.
426
If it is bound, then most of the commit will actually be
427
done using the remote branch as the target branch.
428
Only at the end will the local branch be updated.
430
if self.local and not self.branch.get_bound_location():
431
raise errors.LocalRequiresBoundBranch()
434
self.master_branch = self.branch.get_master_branch()
436
if not self.master_branch:
437
# make this branch the reference branch for out of date checks.
438
self.master_branch = self.branch
441
# If the master branch is bound, we must fail
442
master_bound_location = self.master_branch.get_bound_location()
443
if master_bound_location:
444
raise errors.CommitToDoubleBoundBranch(self.branch,
445
self.master_branch, master_bound_location)
447
# TODO: jam 20051230 We could automatically push local
448
# commits to the remote branch if they would fit.
449
# But for now, just require remote to be identical
452
# Make sure the local branch is identical to the master
453
master_info = self.master_branch.last_revision_info()
454
local_info = self.branch.last_revision_info()
455
if local_info != master_info:
456
raise errors.BoundBranchOutOfDate(self.branch,
459
# Now things are ready to change the master branch
461
self.bound_branch = self.branch
462
self.master_branch.lock_write()
463
self.master_locked = True
465
def _check_out_of_date_tree(self):
466
"""Check that the working tree is up to date.
468
:return: old_revision_number,new_revision_number tuple
471
first_tree_parent = self.work_tree.get_parent_ids()[0]
473
# if there are no parents, treat our parent as 'None'
474
# this is so that we still consider the master branch
475
# - in a checkout scenario the tree may have no
476
# parents but the branch may do.
477
first_tree_parent = bzrlib.revision.NULL_REVISION
478
old_revno, master_last = self.master_branch.last_revision_info()
479
if master_last != first_tree_parent:
480
if master_last != bzrlib.revision.NULL_REVISION:
481
raise errors.OutOfDateTree(self.work_tree)
482
if self.branch.repository.has_revision(first_tree_parent):
483
new_revno = old_revno + 1
485
# ghost parents never appear in revision history.
487
return old_revno,new_revno
489
def _process_pre_hooks(self, old_revno, new_revno):
490
"""Process any registered pre commit hooks."""
491
self._set_progress_stage("Running pre_commit hooks")
492
self._process_hooks("pre_commit", old_revno, new_revno)
494
def _process_post_hooks(self, old_revno, new_revno):
495
"""Process any registered post commit hooks."""
496
# Process the post commit hooks, if any
497
self._set_progress_stage("Running post_commit hooks")
498
# old style commit hooks - should be deprecated ? (obsoleted in
500
if self.config.post_commit() is not None:
501
hooks = self.config.post_commit().split(' ')
502
# this would be nicer with twisted.python.reflect.namedAny
504
result = eval(hook + '(branch, rev_id)',
505
{'branch':self.branch,
507
'rev_id':self.rev_id})
508
# process new style post commit hooks
509
self._process_hooks("post_commit", old_revno, new_revno)
511
def _process_hooks(self, hook_name, old_revno, new_revno):
512
if not Branch.hooks[hook_name]:
515
# new style commit hooks:
516
if not self.bound_branch:
517
hook_master = self.branch
520
hook_master = self.master_branch
521
hook_local = self.branch
522
# With bound branches, when the master is behind the local branch,
523
# the 'old_revno' and old_revid values here are incorrect.
524
# XXX: FIXME ^. RBC 20060206
526
old_revid = self.parents[0]
528
old_revid = bzrlib.revision.NULL_REVISION
530
if hook_name == "pre_commit":
531
future_tree = self.builder.revision_tree()
532
tree_delta = future_tree.changes_from(self.basis_tree,
535
for hook in Branch.hooks[hook_name]:
536
# show the running hook in the progress bar. As hooks may
537
# end up doing nothing (e.g. because they are not configured by
538
# the user) this is still showing progress, not showing overall
539
# actions - its up to each plugin to show a UI if it want's to
540
# (such as 'Emailing diff to foo@example.com').
541
self.pb_stage_name = "Running %s hooks [%s]" % \
542
(hook_name, Branch.hooks.get_hook_name(hook))
543
self._emit_progress()
544
if 'hooks' in debug.debug_flags:
545
mutter("Invoking commit hook: %r", hook)
546
if hook_name == "post_commit":
547
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
549
elif hook_name == "pre_commit":
550
hook(hook_local, hook_master,
551
old_revno, old_revid, new_revno, self.rev_id,
552
tree_delta, future_tree)
555
"""Cleanup any open locks, progress bars etc."""
556
cleanups = [self._cleanup_bound_branch,
557
self.basis_tree.unlock,
558
self.work_tree.unlock,
560
found_exception = None
561
for cleanup in cleanups:
564
# we want every cleanup to run no matter what.
565
# so we have a catchall here, but we will raise the
566
# last encountered exception up the stack: and
567
# typically this will be useful enough.
570
if found_exception is not None:
571
# don't do a plan raise, because the last exception may have been
572
# trashed, e is our sure-to-work exception even though it loses the
573
# full traceback. XXX: RBC 20060421 perhaps we could check the
574
# exc_info and if its the same one do a plain raise otherwise
575
# 'raise e' as we do now.
578
def _cleanup_bound_branch(self):
579
"""Executed at the end of a try/finally to cleanup a bound branch.
581
If the branch wasn't bound, this is a no-op.
582
If it was, it resents self.branch to the local branch, instead
585
if not self.bound_branch:
587
if self.master_locked:
588
self.master_branch.unlock()
590
def _escape_commit_message(self):
591
"""Replace xml-incompatible control characters."""
592
# FIXME: RBC 20060419 this should be done by the revision
593
# serialiser not by commit. Then we can also add an unescaper
594
# in the deserializer and start roundtripping revision messages
595
# precisely. See repository_implementations/test_repository.py
597
# Python strings can include characters that can't be
598
# represented in well-formed XML; escape characters that
599
# aren't listed in the XML specification
600
# (http://www.w3.org/TR/REC-xml/#NT-Char).
601
self.message, escape_count = re.subn(
602
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
603
lambda match: match.group(0).encode('unicode_escape'),
606
self.reporter.escaped(escape_count, self.message)
608
def _gather_parents(self):
609
"""Record the parents of a merge for merge detection."""
610
# TODO: Make sure that this list doesn't contain duplicate
611
# entries and the order is preserved when doing this.
612
self.parents = self.work_tree.get_parent_ids()
613
self.parent_invs = [self.basis_inv]
614
for revision in self.parents[1:]:
615
if self.branch.repository.has_revision(revision):
616
mutter('commit parent revision {%s}', revision)
617
inventory = self.branch.repository.get_inventory(revision)
618
self.parent_invs.append(inventory)
620
mutter('commit parent ghost revision {%s}', revision)
622
def _update_builder_with_changes(self):
623
"""Update the commit builder with the data about what has changed.
625
# Build the revision inventory.
627
# This starts by creating a new empty inventory. Depending on
628
# which files are selected for commit, and what is present in the
629
# current tree, the new inventory is populated. inventory entries
630
# which are candidates for modification have their revision set to
631
# None; inventory entries that are carried over untouched have their
632
# revision set to their prior value.
634
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
635
# results to create a new inventory at the same time, which results
636
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
639
specific_files = self.specific_files
640
mutter("Selecting files for commit with filter %s", specific_files)
642
# Build the new inventory
643
self._populate_from_inventory(specific_files)
645
# If specific files are selected, then all un-selected files must be
646
# recorded in their previous state. For more details, see
647
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
649
for path, old_ie in self.basis_inv.iter_entries():
650
if old_ie.file_id in self.builder.new_inventory:
651
# already added - skip.
653
if is_inside_any(specific_files, path):
654
# was inside the selected path, if not present it has been
657
if old_ie.kind == 'directory':
658
self._next_progress_entry()
659
# not in final inv yet, was not in the selected files, so is an
660
# entry to be preserved unaltered.
662
# Note: specific file commits after a merge are currently
663
# prohibited. This test is for sanity/safety in case it's
664
# required after that changes.
665
if len(self.parents) > 1:
667
delta, version_recorded = self.builder.record_entry_contents(
668
ie, self.parent_invs, path, self.basis_tree, None)
670
self.any_entries_changed = True
671
if delta: self._basis_delta.append(delta)
673
def _report_and_accumulate_deletes(self):
674
# XXX: Could the list of deleted paths and ids be instead taken from
675
# _populate_from_inventory?
676
deleted_ids = set(self.basis_inv._byid.keys()) - \
677
set(self.builder.new_inventory._byid.keys())
679
self.any_entries_deleted = True
680
deleted = [(self.basis_tree.id2path(file_id), file_id)
681
for file_id in deleted_ids]
683
# XXX: this is not quite directory-order sorting
684
for path, file_id in deleted:
685
self._basis_delta.append((path, None, file_id, None))
686
self.reporter.deleted(path)
688
def _populate_from_inventory(self, specific_files):
689
"""Populate the CommitBuilder by walking the working tree inventory."""
691
# raise an exception as soon as we find a single unknown.
692
for unknown in self.work_tree.unknowns():
693
raise StrictCommitFailed()
695
report_changes = self.reporter.is_verbose()
697
deleted_paths = set()
698
# XXX: Note that entries may have the wrong kind because the entry does
699
# not reflect the status on disk.
700
work_inv = self.work_tree.inventory
701
entries = work_inv.iter_entries_by_dir(
702
specific_file_ids=self.specific_file_ids, yield_parents=True)
703
for path, existing_ie in entries:
704
file_id = existing_ie.file_id
705
name = existing_ie.name
706
parent_id = existing_ie.parent_id
707
kind = existing_ie.kind
708
if kind == 'directory':
709
self._next_progress_entry()
710
# Skip files that have been deleted from the working tree.
711
# The deleted files/directories are also recorded so they
712
# can be explicitly unversioned later. Note that when a
713
# filter of specific files is given, we must only skip/record
714
# deleted files matching that filter.
715
if is_inside_any(deleted_paths, path):
717
content_summary = self.work_tree.path_content_summary(path)
718
if not specific_files or is_inside_any(specific_files, path):
719
if content_summary[0] == 'missing':
720
deleted_paths.add(path)
721
self.reporter.missing(path)
722
deleted_ids.append(file_id)
724
# TODO: have the builder do the nested commit just-in-time IF and
726
if content_summary[0] == 'tree-reference':
727
# enforce repository nested tree policy.
728
if (not self.work_tree.supports_tree_reference() or
729
# repository does not support it either.
730
not self.branch.repository._format.supports_tree_reference):
731
content_summary = ('directory',) + content_summary[1:]
732
kind = content_summary[0]
733
# TODO: specific_files filtering before nested tree processing
734
if kind == 'tree-reference':
735
if self.recursive == 'down':
736
nested_revision_id = self._commit_nested_tree(
738
content_summary = content_summary[:3] + (
741
content_summary = content_summary[:3] + (
742
self.work_tree.get_reference_revision(file_id),)
744
# Record an entry for this item
745
# Note: I don't particularly want to have the existing_ie
746
# parameter but the test suite currently (28-Jun-07) breaks
747
# without it thanks to a unicode normalisation issue. :-(
748
definitely_changed = kind != existing_ie.kind
749
self._record_entry(path, file_id, specific_files, kind, name,
750
parent_id, definitely_changed, existing_ie, report_changes,
753
# Unversion IDs that were found to be deleted
754
self.work_tree.unversion(deleted_ids)
756
def _commit_nested_tree(self, file_id, path):
757
"Commit a nested tree."
758
sub_tree = self.work_tree.get_nested_tree(file_id, path)
759
# FIXME: be more comprehensive here:
760
# this works when both trees are in --trees repository,
761
# but when both are bound to a different repository,
762
# it fails; a better way of approaching this is to
763
# finally implement the explicit-caches approach design
764
# a while back - RBC 20070306.
765
if sub_tree.branch.repository.has_same_location(
766
self.work_tree.branch.repository):
767
sub_tree.branch.repository = \
768
self.work_tree.branch.repository
770
return sub_tree.commit(message=None, revprops=self.revprops,
771
recursive=self.recursive,
772
message_callback=self.message_callback,
773
timestamp=self.timestamp, timezone=self.timezone,
774
committer=self.committer,
775
allow_pointless=self.allow_pointless,
776
strict=self.strict, verbose=self.verbose,
777
local=self.local, reporter=self.reporter)
778
except errors.PointlessCommit:
779
return self.work_tree.get_reference_revision(file_id)
781
def _record_entry(self, path, file_id, specific_files, kind, name,
782
parent_id, definitely_changed, existing_ie, report_changes,
784
"Record the new inventory entry for a path if any."
785
# mutter('check %s {%s}', path, file_id)
786
# mutter('%s selected for commit', path)
787
if definitely_changed or existing_ie is None:
788
ie = make_entry(kind, name, parent_id, file_id)
790
ie = existing_ie.copy()
792
delta, version_recorded = self.builder.record_entry_contents(ie,
793
self.parent_invs, path, self.work_tree, content_summary)
795
self._basis_delta.append(delta)
797
self.any_entries_changed = True
799
self._report_change(ie, path)
802
def _report_change(self, ie, path):
803
"""Report a change to the user.
805
The change that has occurred is described relative to the basis
808
if (self.basis_inv.has_id(ie.file_id)):
809
basis_ie = self.basis_inv[ie.file_id]
812
change = ie.describe_change(basis_ie, ie)
813
if change in (InventoryEntry.RENAMED,
814
InventoryEntry.MODIFIED_AND_RENAMED):
815
old_path = self.basis_inv.id2path(ie.file_id)
816
self.reporter.renamed(change, old_path, path)
818
self.reporter.snapshot_change(change, path)
820
def _set_progress_stage(self, name, entries_title=None):
821
"""Set the progress stage and emit an update to the progress bar."""
822
self.pb_stage_name = name
823
self.pb_stage_count += 1
824
self.pb_entries_title = entries_title
825
if entries_title is not None:
826
self.pb_entries_count = 0
827
self.pb_entries_total = '?'
828
self._emit_progress()
830
def _next_progress_entry(self):
831
"""Emit an update to the progress bar and increment the entry count."""
832
self.pb_entries_count += 1
833
self._emit_progress()
835
def _emit_progress(self):
836
if self.pb_entries_title:
837
if self.pb_entries_total == '?':
838
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
839
self.pb_entries_title, self.pb_entries_count)
841
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
842
self.pb_entries_title, self.pb_entries_count,
843
str(self.pb_entries_total))
845
text = "%s - Stage" % (self.pb_stage_name)
846
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
