1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1
# Copyright (C) 2005 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
18
# The newly committed revision is going to have a shape corresponding
19
# to that of the working inventory. 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 inventory, 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.
18
## XXX: Can we do any better about making interrupted commits change
21
## XXX: If we merged two versions of a file then we still need to
22
## create a new version representing that merge, even if it didn't
23
## change from the parent.
25
## TODO: Read back the just-generated changeset, and make sure it
26
## applies and recreates the right state.
37
from binascii import hexlify
57
38
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
40
from bzrlib.osutils import (local_time_offset, username,
41
rand_bytes, compact_date, user_email,
42
kind_marker, is_inside_any, quotefn,
43
sha_string, sha_strings, sha_file, isdir, isfile)
44
from bzrlib.branch import gen_file_id, INVENTORY_FILEID, ANCESTRY_FILEID
45
from bzrlib.errors import BzrError, PointlessCommit
46
from bzrlib.revision import Revision, RevisionReference
47
from bzrlib.trace import mutter, note
77
48
from bzrlib.xml5 import serializer_v5
78
from bzrlib.inventory import Inventory, InventoryEntry
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
49
from bzrlib.inventory import Inventory
50
from bzrlib.delta import compare_trees
51
from bzrlib.weave import Weave
52
from bzrlib.weavefile import read_weave, write_weave_v5
53
from bzrlib.atomicfile import AtomicFile
56
def commit(*args, **kwargs):
57
"""Commit a new revision to a branch.
59
Function-style interface for convenience of old callers.
61
New code should use the Commit class instead.
63
Commit().commit(*args, **kwargs)
88
66
class NullCommitReporter(object):
89
67
"""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):
68
def added(self, path):
71
def removed(self, path):
74
def renamed(self, old_path, new_path):
116
78
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):
79
def added(self, path):
80
note('added %s', path)
82
def removed(self, path):
83
note('removed %s', path)
85
def renamed(self, old_path, new_path):
86
note('renamed %s => %s', old_path, new_path)
158
89
class Commit(object):
168
99
working inventory.
170
101
def __init__(self,
173
"""Create a Commit object.
175
:param reporter: the default reporter to use or None to decide later
177
self.reporter = reporter
103
if reporter is not None:
104
self.reporter = reporter
106
self.reporter = NullCommitReporter()
185
114
specific_files=None,
187
allow_pointless=True,
195
message_callback=None,
116
allow_pointless=True):
197
117
"""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.
119
The basic approach is to add all the file texts into the
120
store, then the inventory, then make a new revision pointing
121
to that inventory and store that.
123
This is not quite safe if the working copy changes during the
124
commit; for the moment that is simply not allowed. A better
125
approach is to make a temporary copy of the files before
126
computing their hashes, and then add those hashes in turn to
127
the inventory. This should mean at least that there are no
128
broken hash pointers. There is no way we can get a snapshot
129
of the whole directory at an instant. This would also have to
130
be robust against files disappearing, moving, etc. So the
131
whole thing is a bit hard.
133
This raises PointlessCommit if there are no changes, no new merges,
134
and allow_pointless is false.
136
timestamp -- if not None, seconds-since-epoch for a
137
postdated/predated commit.
140
If true, commit only those files.
143
If set, use this as the new revision id.
207
144
Useful for test or import commands that need to tightly
208
145
control what revisions are assigned. If you duplicate
209
146
a revision id that exists elsewhere it is your own fault.
210
147
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
251
if specific_files is not None:
252
self.specific_files = sorted(
253
minimum_path_selection(specific_files))
255
self.specific_files = None
256
self.specific_file_ids = None
151
self.branch.lock_write()
153
self.specific_files = specific_files
257
154
self.allow_pointless = allow_pointless
258
self.recursive = recursive
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
267
self.work_tree.lock_write()
268
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
269
self.basis_tree = self.work_tree.basis_tree()
270
self.basis_tree.lock_read()
156
if timestamp is None:
157
self.timestamp = time.time()
159
self.timestamp = long(timestamp)
161
if committer is None:
162
self.committer = username(self.branch)
164
assert isinstance(committer, basestring), type(committer)
165
self.committer = committer
168
self.timezone = local_time_offset()
170
self.timezone = int(timezone)
172
assert isinstance(message, basestring), type(message)
173
self.message = message
272
# Cannot commit with conflicts present.
273
if len(self.work_tree.conflicts()) > 0:
274
raise ConflictsInTree
276
# Setup the bound branch variables as needed.
277
self._check_bound_branch()
279
# Check that the working tree is up to date
280
old_revno, new_revno = self._check_out_of_date_tree()
282
# Complete configuration setup
283
if reporter is not None:
284
self.reporter = reporter
285
elif self.reporter is None:
286
self.reporter = self._select_reporter()
287
if self.config is None:
288
self.config = self.branch.get_config()
290
# If provided, ensure the specified files are versioned
291
if self.specific_files is not None:
293
# is being called because it raises PathNotVerisonedError
294
# as a side effect of finding the IDs. We later use the ids we
295
# found as input to the working tree inventory iterator, so we
296
# only consider those ids rather than examining the whole tree
298
# XXX: Dont we have filter_unversioned to do this more
300
self.specific_file_ids = tree.find_ids_across_trees(
301
specific_files, [self.basis_tree, self.work_tree])
303
# Setup the progress bar. As the number of files that need to be
304
# committed in unknown, progress is reported as stages.
305
# We keep track of entries separately though and include that
306
# information in the progress bar during the relevant stages.
307
self.pb_stage_name = ""
308
self.pb_stage_count = 0
309
self.pb_stage_total = 5
310
if self.bound_branch:
311
self.pb_stage_total += 1
312
self.pb.show_pct = False
313
self.pb.show_spinner = False
314
self.pb.show_eta = False
315
self.pb.show_count = True
316
self.pb.show_bar = True
318
# After a merge, a selected file commit is not supported.
319
# See 'bzr help merge' for an explanation as to why.
176
# First walk over the working inventory; and both update that
177
# and also build a new revision inventory. The revision
178
# inventory needs to hold the text-id, sha1 and size of the
179
# actual file versions committed in the revision. (These are
180
# not present in the working inventory.) We also need to
181
# detect missing/deleted files, and remove them from the
184
self.work_tree = self.branch.working_tree()
185
self.work_inv = self.work_tree.inventory
186
self.basis_tree = self.branch.basis_tree()
320
187
self.basis_inv = self.basis_tree.inventory
321
189
self._gather_parents()
322
if len(self.parents) > 1 and self.specific_files:
323
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
325
# Collect the changes
326
self._set_progress_stage("Collecting changes",
327
entries_title="Directory")
328
self.builder = self.branch.get_commit_builder(self.parents,
329
self.config, timestamp, timezone, committer, revprops, rev_id)
332
# find the location being committed to
333
if self.bound_branch:
334
master_location = self.master_branch.base
336
master_location = self.branch.base
338
# report the start of the commit
339
self.reporter.started(new_revno, self.rev_id, master_location)
341
self._update_builder_with_changes()
342
self._check_pointless()
344
# TODO: Now the new inventory is known, check for conflicts.
345
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
346
# weave lines, because nothing should be recorded until it is known
347
# that commit will succeed.
348
self._set_progress_stage("Saving data locally")
349
self.builder.finish_inventory()
351
# Prompt the user for a commit message if none provided
352
message = message_callback(self)
353
assert isinstance(message, unicode), type(message)
354
self.message = message
355
self._escape_commit_message()
357
# Add revision data to the local branch
358
self.rev_id = self.builder.commit(self.message)
364
self._process_pre_hooks(old_revno, new_revno)
366
# Upload revision data to the master.
367
# this will propagate merged revisions too if needed.
368
if self.bound_branch:
369
self._set_progress_stage("Uploading data to master branch")
370
self.master_branch.repository.fetch(self.branch.repository,
371
revision_id=self.rev_id)
372
# now the master has the revision data
373
# 'commit' to the master first so a timeout here causes the
374
# local branch to be out of date
375
self.master_branch.set_last_revision_info(new_revno,
378
# and now do the commit locally.
379
self.branch.set_last_revision_info(new_revno, self.rev_id)
381
# Make the working tree up to date with the branch
382
self._set_progress_stage("Updating the working tree")
383
rev_tree = self.builder.revision_tree()
384
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
385
self.reporter.completed(new_revno, self.rev_id)
386
self._process_post_hooks(old_revno, new_revno)
191
if self.rev_id is None:
192
self.rev_id = _gen_revision_id(self.branch, time.time())
194
# TODO: update hashcache
195
self.delta = compare_trees(self.basis_tree, self.work_tree,
196
specific_files=self.specific_files)
198
if not (self.delta.has_changed()
199
or self.allow_pointless
200
or len(self.parents) != 1):
201
raise PointlessCommit()
203
self.new_inv = self.basis_inv.copy()
205
self.delta.show(sys.stdout)
207
self._remove_deleted()
210
self.branch._write_inventory(self.work_inv)
211
self._record_inventory()
212
self._record_ancestry()
214
self._make_revision()
215
note('committted r%d {%s}', (self.branch.revno() + 1),
217
self.branch.append_revision(self.rev_id)
218
self.branch.set_pending_merges([])
391
def _select_reporter(self):
392
"""Select the CommitReporter to use."""
394
return NullCommitReporter()
395
return ReportCommitToLog()
397
def _check_pointless(self):
398
if self.allow_pointless:
400
# A merge with no effect on files
223
def _record_inventory(self):
224
"""Store the inventory for the new revision."""
226
serializer_v5.write_inventory(self.new_inv, inv_tmp)
228
self.inv_sha1 = sha_string(inv_tmp.getvalue())
229
inv_lines = inv_tmp.readlines()
230
self.branch.weave_store.add_text(INVENTORY_FILEID, self.rev_id,
231
inv_lines, self.parents)
234
def _record_ancestry(self):
235
"""Append merged revision ancestry to the ancestry file."""
401
236
if len(self.parents) > 1:
403
# work around the fact that a newly-initted tree does differ from its
405
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
406
raise PointlessCommit()
407
# Shortcut, if the number of entries changes, then we obviously have
409
if len(self.builder.new_inventory) != len(self.basis_inv):
411
# If length == 1, then we only have the root entry. Which means
412
# that there is no real difference (only the root could be different)
413
if len(self.builder.new_inventory) != 1 and (self.any_entries_changed
414
or self.any_entries_deleted):
416
raise PointlessCommit()
418
def _check_bound_branch(self):
419
"""Check to see if the local branch is bound.
421
If it is bound, then most of the commit will actually be
422
done using the remote branch as the target branch.
423
Only at the end will the local branch be updated.
425
if self.local and not self.branch.get_bound_location():
426
raise errors.LocalRequiresBoundBranch()
429
self.master_branch = self.branch.get_master_branch()
431
if not self.master_branch:
432
# make this branch the reference branch for out of date checks.
433
self.master_branch = self.branch
436
# If the master branch is bound, we must fail
437
master_bound_location = self.master_branch.get_bound_location()
438
if master_bound_location:
439
raise errors.CommitToDoubleBoundBranch(self.branch,
440
self.master_branch, master_bound_location)
442
# TODO: jam 20051230 We could automatically push local
443
# commits to the remote branch if they would fit.
444
# But for now, just require remote to be identical
447
# Make sure the local branch is identical to the master
448
master_info = self.master_branch.last_revision_info()
449
local_info = self.branch.last_revision_info()
450
if local_info != master_info:
451
raise errors.BoundBranchOutOfDate(self.branch,
454
# Now things are ready to change the master branch
456
self.bound_branch = self.branch
457
self.master_branch.lock_write()
458
self.master_locked = True
460
def _check_out_of_date_tree(self):
461
"""Check that the working tree is up to date.
463
:return: old_revision_number,new_revision_number tuple
466
first_tree_parent = self.work_tree.get_parent_ids()[0]
468
# if there are no parents, treat our parent as 'None'
469
# this is so that we still consider the master branch
470
# - in a checkout scenario the tree may have no
471
# parents but the branch may do.
472
first_tree_parent = bzrlib.revision.NULL_REVISION
473
old_revno, master_last = self.master_branch.last_revision_info()
474
if master_last != first_tree_parent:
475
if master_last != bzrlib.revision.NULL_REVISION:
476
raise errors.OutOfDateTree(self.work_tree)
477
if self.branch.repository.has_revision(first_tree_parent):
478
new_revno = old_revno + 1
480
# ghost parents never appear in revision history.
482
return old_revno,new_revno
484
def _process_pre_hooks(self, old_revno, new_revno):
485
"""Process any registered pre commit hooks."""
486
self._set_progress_stage("Running pre_commit hooks")
487
self._process_hooks("pre_commit", old_revno, new_revno)
489
def _process_post_hooks(self, old_revno, new_revno):
490
"""Process any registered post commit hooks."""
491
# Process the post commit hooks, if any
492
self._set_progress_stage("Running post_commit hooks")
493
# old style commit hooks - should be deprecated ? (obsoleted in
495
if self.config.post_commit() is not None:
496
hooks = self.config.post_commit().split(' ')
497
# this would be nicer with twisted.python.reflect.namedAny
499
result = eval(hook + '(branch, rev_id)',
500
{'branch':self.branch,
502
'rev_id':self.rev_id})
503
# process new style post commit hooks
504
self._process_hooks("post_commit", old_revno, new_revno)
506
def _process_hooks(self, hook_name, old_revno, new_revno):
507
if not Branch.hooks[hook_name]:
510
# new style commit hooks:
511
if not self.bound_branch:
512
hook_master = self.branch
515
hook_master = self.master_branch
516
hook_local = self.branch
517
# With bound branches, when the master is behind the local branch,
518
# the 'old_revno' and old_revid values here are incorrect.
519
# XXX: FIXME ^. RBC 20060206
237
raise NotImplementedError("sorry, can't commit merges yet")
238
w = self.branch.weave_store.get_weave_or_empty(ANCESTRY_FILEID)
521
old_revid = self.parents[0]
240
lines = w.get(w.lookup(self.parents[0]))
523
old_revid = bzrlib.revision.NULL_REVISION
525
if hook_name == "pre_commit":
526
future_tree = self.builder.revision_tree()
527
tree_delta = future_tree.changes_from(self.basis_tree,
530
for hook in Branch.hooks[hook_name]:
531
# show the running hook in the progress bar. As hooks may
532
# end up doing nothing (e.g. because they are not configured by
533
# the user) this is still showing progress, not showing overall
534
# actions - its up to each plugin to show a UI if it want's to
535
# (such as 'Emailing diff to foo@example.com').
536
self.pb_stage_name = "Running %s hooks [%s]" % \
537
(hook_name, Branch.hooks.get_hook_name(hook))
538
self._emit_progress()
539
if 'hooks' in debug.debug_flags:
540
mutter("Invoking commit hook: %r", hook)
541
if hook_name == "post_commit":
542
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
544
elif hook_name == "pre_commit":
545
hook(hook_local, hook_master,
546
old_revno, old_revid, new_revno, self.rev_id,
547
tree_delta, future_tree)
550
"""Cleanup any open locks, progress bars etc."""
551
cleanups = [self._cleanup_bound_branch,
552
self.basis_tree.unlock,
553
self.work_tree.unlock,
555
found_exception = None
556
for cleanup in cleanups:
559
# we want every cleanup to run no matter what.
560
# so we have a catchall here, but we will raise the
561
# last encountered exception up the stack: and
562
# typically this will be useful enough.
565
if found_exception is not None:
566
# don't do a plan raise, because the last exception may have been
567
# trashed, e is our sure-to-work exception even though it loses the
568
# full traceback. XXX: RBC 20060421 perhaps we could check the
569
# exc_info and if its the same one do a plain raise otherwise
570
# 'raise e' as we do now.
573
def _cleanup_bound_branch(self):
574
"""Executed at the end of a try/finally to cleanup a bound branch.
576
If the branch wasn't bound, this is a no-op.
577
If it was, it resents self.branch to the local branch, instead
580
if not self.bound_branch:
582
if self.master_locked:
583
self.master_branch.unlock()
585
def _escape_commit_message(self):
586
"""Replace xml-incompatible control characters."""
587
# FIXME: RBC 20060419 this should be done by the revision
588
# serialiser not by commit. Then we can also add an unescaper
589
# in the deserializer and start roundtripping revision messages
590
# precisely. See repository_implementations/test_repository.py
592
# Python strings can include characters that can't be
593
# represented in well-formed XML; escape characters that
594
# aren't listed in the XML specification
595
# (http://www.w3.org/TR/REC-xml/#NT-Char).
596
self.message, escape_count = re.subn(
597
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
598
lambda match: match.group(0).encode('unicode_escape'),
601
self.reporter.escaped(escape_count, self.message)
243
lines.append(self.rev_id + '\n')
244
parent_idxs = map(w.lookup, self.parents)
245
w.add(self.rev_id, parent_idxs, lines)
246
self.branch.weave_store.put_weave(ANCESTRY_FILEID, w)
603
249
def _gather_parents(self):
604
"""Record the parents of a merge for merge detection."""
605
# TODO: Make sure that this list doesn't contain duplicate
606
# entries and the order is preserved when doing this.
607
self.parents = self.work_tree.get_parent_ids()
608
self.parent_invs = [self.basis_inv]
609
for revision in self.parents[1:]:
610
if self.branch.repository.has_revision(revision):
611
mutter('commit parent revision {%s}', revision)
612
inventory = self.branch.repository.get_inventory(revision)
613
self.parent_invs.append(inventory)
615
mutter('commit parent ghost revision {%s}', revision)
617
def _update_builder_with_changes(self):
618
"""Update the commit builder with the data about what has changed.
620
# Build the revision inventory.
622
# This starts by creating a new empty inventory. Depending on
623
# which files are selected for commit, and what is present in the
624
# current tree, the new inventory is populated. inventory entries
625
# which are candidates for modification have their revision set to
626
# None; inventory entries that are carried over untouched have their
627
# revision set to their prior value.
629
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
630
# results to create a new inventory at the same time, which results
631
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
634
specific_files = self.specific_files
635
mutter("Selecting files for commit with filter %s", specific_files)
637
# Check and warn about old CommitBuilders
638
if not self.builder.record_root_entry:
639
symbol_versioning.warn('CommitBuilders should support recording'
640
' the root entry as of bzr 0.10.', DeprecationWarning,
642
self.builder.new_inventory.add(self.basis_inv.root.copy())
644
# Build the new inventory
645
self._populate_from_inventory(specific_files)
647
# If specific files are selected, then all un-selected files must be
648
# recorded in their previous state. For more details, see
649
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
651
for path, old_ie in self.basis_inv.iter_entries():
652
if old_ie.file_id in self.builder.new_inventory:
654
if is_inside_any(specific_files, path):
656
if old_ie.kind == 'directory':
657
self._next_progress_entry()
659
# Note: specific file commits after a merge are currently
660
# prohibited. This test is for sanity/safety in case it's
661
# required after that changes.
662
if len(self.parents) > 1:
664
if self.builder.record_entry_contents(ie, self.parent_invs, path,
666
self.any_entries_changed = True
668
# note that deletes have occurred
669
if set(self.basis_inv._byid.keys()) - set(self.builder.new_inventory._byid.keys()):
670
self.any_entries_deleted = True
671
# Report what was deleted.
672
if self.any_entries_deleted and self.reporter.is_verbose():
673
for path, ie in self.basis_inv.iter_entries():
674
if ie.file_id not in self.builder.new_inventory:
675
self.reporter.deleted(path)
677
def _populate_from_inventory(self, specific_files):
678
"""Populate the CommitBuilder by walking the working tree inventory."""
680
# raise an exception as soon as we find a single unknown.
681
for unknown in self.work_tree.unknowns():
682
raise StrictCommitFailed()
684
report_changes = self.reporter.is_verbose()
686
deleted_paths = set()
687
work_inv = self.work_tree.inventory
688
assert work_inv.root is not None
689
entries = work_inv.iter_entries_by_dir(
690
specific_file_ids=self.specific_file_ids, yield_parents=True)
691
if not self.builder.record_root_entry:
693
for path, existing_ie in entries:
694
file_id = existing_ie.file_id
695
name = existing_ie.name
696
parent_id = existing_ie.parent_id
697
kind = existing_ie.kind
698
if kind == 'directory':
699
self._next_progress_entry()
700
# Skip files that have been deleted from the working tree.
701
# The deleted files/directories are also recorded so they
702
# can be explicitly unversioned later. Note that when a
703
# filter of specific files is given, we must only skip/record
704
# deleted files matching that filter.
705
if is_inside_any(deleted_paths, path):
707
if not self.work_tree.has_filename(path):
708
deleted_paths.add(path)
709
self.reporter.missing(path)
710
deleted_ids.append(file_id)
713
kind = self.work_tree.kind(file_id)
714
# TODO: specific_files filtering before nested tree processing
715
if kind == 'tree-reference' and self.recursive == 'down':
716
self._commit_nested_tree(file_id, path)
717
except errors.NoSuchFile:
720
# Record an entry for this item
721
# Note: I don't particularly want to have the existing_ie
722
# parameter but the test suite currently (28-Jun-07) breaks
723
# without it thanks to a unicode normalisation issue. :-(
724
definitely_changed = kind != existing_ie.kind
725
self._record_entry(path, file_id, specific_files, kind, name,
726
parent_id, definitely_changed, existing_ie, report_changes)
728
# Unversion IDs that were found to be deleted
729
self.work_tree.unversion(deleted_ids)
731
def _commit_nested_tree(self, file_id, path):
732
"Commit a nested tree."
733
sub_tree = self.work_tree.get_nested_tree(file_id, path)
734
# FIXME: be more comprehensive here:
735
# this works when both trees are in --trees repository,
736
# but when both are bound to a different repository,
737
# it fails; a better way of approaching this is to
738
# finally implement the explicit-caches approach design
739
# a while back - RBC 20070306.
740
if sub_tree.branch.repository.has_same_location(
741
self.work_tree.branch.repository):
742
sub_tree.branch.repository = \
743
self.work_tree.branch.repository
745
sub_tree.commit(message=None, revprops=self.revprops,
746
recursive=self.recursive,
747
message_callback=self.message_callback,
748
timestamp=self.timestamp, timezone=self.timezone,
749
committer=self.committer,
750
allow_pointless=self.allow_pointless,
751
strict=self.strict, verbose=self.verbose,
752
local=self.local, reporter=self.reporter)
753
except errors.PointlessCommit:
756
def _record_entry(self, path, file_id, specific_files, kind, name,
757
parent_id, definitely_changed, existing_ie=None,
758
report_changes=True):
759
"Record the new inventory entry for a path if any."
760
# mutter('check %s {%s}', path, file_id)
761
# mutter('%s selected for commit', path)
762
if definitely_changed or existing_ie is None:
763
ie = inventory.make_entry(kind, name, parent_id, file_id)
765
ie = existing_ie.copy()
767
if self.builder.record_entry_contents(ie, self.parent_invs,
768
path, self.work_tree):
769
self.any_entries_changed = True
771
self._report_change(ie, path)
774
def _report_change(self, ie, path):
775
"""Report a change to the user.
777
The change that has occurred is described relative to the basis
780
if (self.basis_inv.has_id(ie.file_id)):
781
basis_ie = self.basis_inv[ie.file_id]
784
change = ie.describe_change(basis_ie, ie)
785
if change in (InventoryEntry.RENAMED,
786
InventoryEntry.MODIFIED_AND_RENAMED):
787
old_path = self.basis_inv.id2path(ie.file_id)
788
self.reporter.renamed(change, old_path, path)
790
self.reporter.snapshot_change(change, path)
792
def _set_progress_stage(self, name, entries_title=None):
793
"""Set the progress stage and emit an update to the progress bar."""
794
self.pb_stage_name = name
795
self.pb_stage_count += 1
796
self.pb_entries_title = entries_title
797
if entries_title is not None:
798
self.pb_entries_count = 0
799
self.pb_entries_total = '?'
800
self._emit_progress()
802
def _next_progress_entry(self):
803
"""Emit an update to the progress bar and increment the entry count."""
804
self.pb_entries_count += 1
805
self._emit_progress()
807
def _emit_progress(self):
808
if self.pb_entries_title:
809
if self.pb_entries_total == '?':
810
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
811
self.pb_entries_title, self.pb_entries_count)
813
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
814
self.pb_entries_title, self.pb_entries_count,
815
str(self.pb_entries_total))
817
text = "%s - Stage" % (self.pb_stage_name)
818
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
250
pending_merges = self.branch.pending_merges()
252
raise NotImplementedError("sorry, can't commit merges to the weave format yet")
254
precursor_id = self.branch.last_patch()
256
self.parents.append(precursor_id)
257
self.parents += pending_merges
260
def _make_revision(self):
261
"""Record a new revision object for this commit."""
262
self.rev = Revision(timestamp=self.timestamp,
263
timezone=self.timezone,
264
committer=self.committer,
265
message=self.message,
266
inventory_sha1=self.inv_sha1,
267
revision_id=self.rev_id)
268
self.rev.parents = map(RevisionReference, self.parents)
269
rev_tmp = tempfile.TemporaryFile()
270
serializer_v5.write_revision(self.rev, rev_tmp)
272
self.branch.revision_store.add(rev_tmp, self.rev_id)
273
mutter('new revision_id is {%s}', self.rev_id)
276
def _remove_deleted(self):
277
"""Remove deleted files from the working and stored inventories."""
278
for path, id, kind in self.delta.removed:
279
if self.work_inv.has_id(id):
280
del self.work_inv[id]
281
if self.new_inv.has_id(id):
286
def _store_files(self):
287
"""Store new texts of modified/added files."""
288
# We must make sure that directories are added before anything
289
# inside them is added. the files within the delta report are
290
# sorted by path so we know the directory will come before its
292
for path, file_id, kind in self.delta.added:
294
ie = self.work_inv[file_id].copy()
297
self._store_file_text(file_id)
299
for path, file_id, kind in self.delta.modified:
302
self._store_file_text(file_id)
304
for old_path, new_path, file_id, kind, text_modified in self.delta.renamed:
307
if not text_modified:
309
self._store_file_text(file_id)
312
def _store_file_text(self, file_id):
313
"""Store updated text for one modified or added file."""
314
note('store new text for {%s} in revision {%s}',
315
file_id, self.rev_id)
316
new_lines = self.work_tree.get_file(file_id).readlines()
317
if file_id in self.new_inv: # was in basis inventory
318
ie = self.new_inv[file_id]
319
assert ie.file_id == file_id
320
assert file_id in self.basis_inv
321
assert self.basis_inv[file_id].kind == 'file'
322
old_version = self.basis_inv[file_id].text_version
323
file_parents = [old_version]
324
else: # new in this revision
325
ie = self.work_inv[file_id].copy()
327
assert file_id not in self.basis_inv
329
assert ie.kind == 'file'
330
self._add_text_to_weave(file_id, new_lines, file_parents)
331
# make a new inventory entry for this file, using whatever
332
# it had in the working copy, plus details on the new text
333
ie.text_sha1 = sha_strings(new_lines)
334
ie.text_size = sum(map(len, new_lines))
335
ie.text_version = self.rev_id
336
ie.entry_version = self.rev_id
339
def _add_text_to_weave(self, file_id, new_lines, parents):
340
if file_id.startswith('__'):
341
raise ValueError('illegal file-id %r for text file' % file_id)
342
self.branch.weave_store.add_text(file_id, self.rev_id, new_lines, parents)
345
def _gen_revision_id(branch, when):
346
"""Return new revision-id."""
347
s = '%s-%s-' % (user_email(branch), compact_date(when))
348
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
