205
147
allow_pointless -- If true (default), commit even if nothing
206
148
has changed and no merges are recorded.
208
strict -- If true, don't allow a commit if the working tree
209
contains unknown files.
211
revprops -- Properties for new revision
212
:param local: Perform a local only commit.
214
mutter('preparing to commit')
216
if deprecated_passed(branch):
217
warn("Commit.commit (branch, ...): The branch parameter is "
218
"deprecated as of bzr 0.8. Please use working_tree= instead.",
219
DeprecationWarning, stacklevel=2)
221
self.work_tree = self.branch.bzrdir.open_workingtree()
222
elif working_tree is None:
223
raise BzrError("One of branch and working_tree must be passed into commit().")
225
self.work_tree = working_tree
226
self.branch = self.work_tree.branch
228
raise BzrError("The message keyword parameter is required for commit().")
230
self.weave_store = self.branch.repository.weave_store
231
self.bound_branch = None
233
self.master_branch = None
234
self.master_locked = False
150
self.any_changes = False
153
self.weave_store = branch.weave_store
235
154
self.rev_id = rev_id
236
155
self.specific_files = specific_files
237
156
self.allow_pointless = allow_pointless
239
if revprops is not None:
240
self.revprops.update(revprops)
242
if reporter is None and self.reporter is None:
243
self.reporter = NullCommitReporter()
244
elif reporter is not None:
245
self.reporter = reporter
247
self.work_tree.lock_write()
158
if timestamp is None:
159
self.timestamp = time.time()
161
self.timestamp = long(timestamp)
164
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
168
if committer is None:
169
self.committer = username(self.branch)
171
assert isinstance(committer, basestring), type(committer)
172
self.committer = committer
175
self.timezone = local_time_offset()
177
self.timezone = int(timezone)
179
assert isinstance(message, basestring), type(message)
180
self.message = message
182
self.branch.lock_write()
249
# setup the bound branch variables as needed.
250
self._check_bound_branch()
252
# check for out of date working trees
253
# if we are bound, then self.branch is the master branch and this
254
# test is thus all we need.
255
if self.work_tree.last_revision() != self.master_branch.last_revision():
256
raise errors.OutOfDateTree(self.work_tree)
259
# raise an exception as soon as we find a single unknown.
260
for unknown in self.work_tree.unknowns():
261
raise StrictCommitFailed()
263
if timestamp is None:
264
self.timestamp = time.time()
266
self.timestamp = long(timestamp)
268
if self.config is None:
269
self.config = bzrlib.config.BranchConfig(self.branch)
272
self.rev_id = _gen_revision_id(self.config, self.timestamp)
276
if committer is None:
277
self.committer = self.config.username()
279
assert isinstance(committer, basestring), type(committer)
280
self.committer = committer
283
self.timezone = local_time_offset()
285
self.timezone = int(timezone)
287
if isinstance(message, str):
288
message = message.decode(bzrlib.user_encoding)
289
assert isinstance(message, unicode), type(message)
290
self.message = message
291
self._escape_commit_message()
184
self.work_tree = self.branch.working_tree()
293
185
self.work_inv = self.work_tree.inventory
294
self.basis_tree = self.work_tree.basis_tree()
186
self.basis_tree = self.branch.basis_tree()
295
187
self.basis_inv = self.basis_tree.inventory
297
189
self._gather_parents()
298
if len(self.parents) > 1 and self.specific_files:
299
raise NotImplementedError('selected-file commit of merges is not supported yet')
300
self._check_parents_present()
302
191
self._remove_deleted()
303
self._populate_new_inv()
304
self._store_snapshot()
192
self.new_inv = Inventory()
305
194
self._report_deletes()
307
196
if not (self.allow_pointless
308
or len(self.parents) > 1
197
or len(self.parents) != 1
309
198
or self.new_inv != self.basis_inv):
310
199
raise PointlessCommit()
312
if len(self.work_tree.conflicts())>0:
313
raise ConflictsInTree
315
self.inv_sha1 = self.branch.repository.add_inventory(
201
self._record_inventory()
202
self._record_ancestry()
320
203
self._make_revision()
321
# revision data is in the local branch now.
323
# upload revision data to the master.
324
# this will propogate merged revisions too if needed.
325
if self.bound_branch:
326
self.master_branch.repository.fetch(self.branch.repository,
327
revision_id=self.rev_id)
328
# now the master has the revision data
329
# 'commit' to the master first so a timeout here causes the local
330
# branch to be out of date
331
self.master_branch.append_revision(self.rev_id)
333
# and now do the commit locally.
204
note('committed r%d {%s}', (self.branch.revno() + 1),
334
206
self.branch.append_revision(self.rev_id)
336
self.work_tree.set_pending_merges([])
337
self.work_tree.set_last_revision(self.rev_id)
338
# now the work tree is up to date with the branch
340
self.reporter.completed(self.branch.revno(), self.rev_id)
341
if self.config.post_commit() is not None:
342
hooks = self.config.post_commit().split(' ')
343
# this would be nicer with twisted.python.reflect.namedAny
345
result = eval(hook + '(branch, rev_id)',
346
{'branch':self.branch,
348
'rev_id':self.rev_id})
207
self.branch.set_pending_merges([])
350
self._cleanup_bound_branch()
351
self.work_tree.unlock()
353
def _check_bound_branch(self):
354
"""Check to see if the local branch is bound.
356
If it is bound, then most of the commit will actually be
357
done using the remote branch as the target branch.
358
Only at the end will the local branch be updated.
360
if self.local and not self.branch.get_bound_location():
361
raise errors.LocalRequiresBoundBranch()
364
self.master_branch = self.branch.get_master_branch()
366
if not self.master_branch:
367
# make this branch the reference branch for out of date checks.
368
self.master_branch = self.branch
371
# If the master branch is bound, we must fail
372
master_bound_location = self.master_branch.get_bound_location()
373
if master_bound_location:
374
raise errors.CommitToDoubleBoundBranch(self.branch,
375
self.master_branch, master_bound_location)
377
# TODO: jam 20051230 We could automatically push local
378
# commits to the remote branch if they would fit.
379
# But for now, just require remote to be identical
382
# Make sure the local branch is identical to the master
383
master_rh = self.master_branch.revision_history()
384
local_rh = self.branch.revision_history()
385
if local_rh != master_rh:
386
raise errors.BoundBranchOutOfDate(self.branch,
389
# Now things are ready to change the master branch
391
self.bound_branch = self.branch
392
self.master_branch.lock_write()
393
self.master_locked = True
395
#### # Check to see if we have any pending merges. If we do
396
#### # those need to be pushed into the master branch
397
#### pending_merges = self.work_tree.pending_merges()
398
#### if pending_merges:
399
#### for revision_id in pending_merges:
400
#### self.master_branch.repository.fetch(self.bound_branch.repository,
401
#### revision_id=revision_id)
403
def _cleanup_bound_branch(self):
404
"""Executed at the end of a try/finally to cleanup a bound branch.
406
If the branch wasn't bound, this is a no-op.
407
If it was, it resents self.branch to the local branch, instead
410
if not self.bound_branch:
412
if self.master_locked:
413
self.master_branch.unlock()
415
def _escape_commit_message(self):
416
"""Replace xml-incompatible control characters."""
417
# Python strings can include characters that can't be
418
# represented in well-formed XML; escape characters that
419
# aren't listed in the XML specification
420
# (http://www.w3.org/TR/REC-xml/#NT-Char).
421
self.message, escape_count = re.subn(
422
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
423
lambda match: match.group(0).encode('unicode_escape'),
426
self.reporter.escaped(escape_count, self.message)
213
def _record_inventory(self):
214
"""Store the inventory for the new revision."""
215
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
216
self.inv_sha1 = sha_string(inv_text)
217
self.weave_store.add_text(INVENTORY_FILEID, self.rev_id,
218
split_lines(inv_text), self.parents)
221
def _record_ancestry(self):
222
"""Append merged revision ancestry to the ancestry file."""
223
w = self.weave_store.get_weave_or_empty(ANCESTRY_FILEID)
225
lines = w.get(w.lookup(self.parents[0]))
228
lines.append(self.rev_id + '\n')
229
parent_idxs = map(w.lookup, self.parents)
230
w.add(self.rev_id, parent_idxs, lines)
231
self.weave_store.put_weave(ANCESTRY_FILEID, w)
428
234
def _gather_parents(self):
429
"""Record the parents of a merge for merge detection."""
430
pending_merges = self.work_tree.pending_merges()
235
pending_merges = self.branch.pending_merges()
431
236
self.parents = []
432
self.parent_invs = []
433
self.present_parents = []
434
237
precursor_id = self.branch.last_revision()
436
239
self.parents.append(precursor_id)
437
240
self.parents += pending_merges
438
for revision in self.parents:
439
if self.branch.repository.has_revision(revision):
440
inventory = self.branch.repository.get_inventory(revision)
441
self.parent_invs.append(inventory)
442
self.present_parents.append(revision)
444
def _check_parents_present(self):
445
for parent_id in self.parents:
446
mutter('commit parent revision {%s}', parent_id)
447
if not self.branch.repository.has_revision(parent_id):
448
if parent_id == self.branch.last_revision():
449
warning("parent is missing %r", parent_id)
450
raise HistoryMissing(self.branch, 'revision', parent_id)
452
mutter("commit will ghost revision %r", parent_id)
241
self.parent_trees = map(self.branch.revision_tree, self.parents)
454
244
def _make_revision(self):
455
245
"""Record a new revision object for this commit."""
456
rev = Revision(timestamp=self.timestamp,
457
timezone=self.timezone,
458
committer=self.committer,
459
message=self.message,
460
inventory_sha1=self.inv_sha1,
461
revision_id=self.rev_id,
462
properties=self.revprops)
463
rev.parent_ids = self.parents
464
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
246
self.rev = Revision(timestamp=self.timestamp,
247
timezone=self.timezone,
248
committer=self.committer,
249
message=self.message,
250
inventory_sha1=self.inv_sha1,
251
revision_id=self.rev_id)
252
self.rev.parents = map(RevisionReference, self.parents)
254
serializer_v5.write_revision(self.rev, rev_tmp)
256
self.branch.revision_store.add(rev_tmp, self.rev_id)
257
mutter('new revision_id is {%s}', self.rev_id)
466
260
def _remove_deleted(self):
467
261
"""Remove deleted files from the working inventories.
480
274
if specific and not is_inside_any(specific, path):
482
276
if not self.work_tree.has_filename(path):
483
self.reporter.missing(path)
484
deleted_ids.append((path, ie.file_id))
277
note('missing %s', path)
278
deleted_ids.append(ie.file_id)
486
deleted_ids.sort(reverse=True)
487
for path, file_id in deleted_ids:
280
for file_id in deleted_ids:
488
281
del self.work_inv[file_id]
489
self.work_tree._write_inventory(self.work_inv)
491
def _store_snapshot(self):
492
"""Pass over inventory and record a snapshot.
494
Entries get a new revision when they are modified in
495
any way, which includes a merge with a new set of
496
parents that have the same entry.
498
# XXX: Need to think more here about when the user has
499
# made a specific decision on a particular value -- c.f.
501
for path, ie in self.new_inv.iter_entries():
502
previous_entries = ie.find_previous_heads(
505
self.branch.repository.get_transaction())
506
if ie.revision is None:
507
change = ie.snapshot(self.rev_id, path, previous_entries,
508
self.work_tree, self.weave_store,
509
self.branch.get_transaction())
512
self.reporter.snapshot_change(change, path)
514
def _populate_new_inv(self):
515
"""Build revision inventory.
517
This creates a new empty inventory. Depending on
518
which files are selected for commit, and what is present in the
519
current tree, the new inventory is populated. inventory entries
520
which are candidates for modification have their revision set to
521
None; inventory entries that are carried over untouched have their
522
revision set to their prior value.
524
mutter("Selecting files for commit with filter %s", self.specific_files)
525
self.new_inv = Inventory(revision_id=self.rev_id)
282
self.branch._write_inventory(self.work_inv)
285
def _find_file_parents(self, file_id):
286
"""Return the text versions and hashes for all file parents.
288
Returned as a map from text version to text sha1.
290
This is a set containing the file versions in all parents
291
revisions containing the file. If the file is new, the set
294
for tree in self.parent_trees:
295
if file_id in tree.inventory:
296
ie = tree.inventory[file_id]
297
assert ie.kind == 'file'
298
assert ie.file_id == file_id
299
if ie.text_version in r:
300
assert r[ie.text_version] == ie.text_sha1
302
r[ie.text_version] = ie.text_sha1
306
def _store_files(self):
307
"""Store new texts of modified/added files.
309
This is called with new_inv set to a copy of the working
310
inventory, with deleted/removed files already cut out. So
311
this code only needs to deal with setting text versions, and
312
possibly recording new file texts."""
526
313
for path, new_ie in self.work_inv.iter_entries():
527
314
file_id = new_ie.file_id
528
315
mutter('check %s {%s}', path, new_ie.file_id)
529
316
if self.specific_files:
530
317
if not is_inside_any(self.specific_files, path):
531
318
mutter('%s not selected for commit', path)
532
self._carry_entry(file_id)
319
self._carry_file(file_id)
535
# this is selected, ensure its parents are too.
536
parent_id = new_ie.parent_id
537
while parent_id != ROOT_ID:
538
if not self.new_inv.has_id(parent_id):
539
ie = self._select_entry(self.work_inv[parent_id])
540
mutter('%s selected for commit because of %s',
541
self.new_inv.id2path(parent_id), path)
543
ie = self.new_inv[parent_id]
544
if ie.revision is not None:
546
mutter('%s selected for commit because of %s',
547
self.new_inv.id2path(parent_id), path)
548
parent_id = ie.parent_id
549
mutter('%s selected for commit', path)
550
self._select_entry(new_ie)
552
def _select_entry(self, new_ie):
553
"""Make new_ie be considered for committing."""
559
def _carry_entry(self, file_id):
560
"""Carry the file unchanged from the basis revision."""
321
if new_ie.kind != 'file':
322
self._commit_nonfile(file_id)
324
file_parents = self._find_file_parents(file_id)
325
wc_sha1 = self.work_tree.get_file_sha1(file_id)
326
if (len(file_parents) == 1
327
and file_parents.values()[0] == wc_sha1):
328
# not changed or merged
329
self._carry_file(file_id)
332
mutter('parents of %s are %r', path, file_parents)
334
# file is either new, or a file merge; need to record
336
if len(file_parents) > 1:
337
note('merged %s', path)
338
elif len(file_parents) == 0:
339
note('added %s', path)
341
note('modified %s', path)
342
self._commit_file(new_ie, file_id, file_parents)
345
def _commit_nonfile(self, file_id):
346
self.new_inv.add(self.work_inv[file_id].copy())
349
def _carry_file(self, file_id):
350
"""Keep a file in the same state as in the basis."""
561
351
if self.basis_inv.has_id(file_id):
562
352
self.new_inv.add(self.basis_inv[file_id].copy())
564
355
def _report_deletes(self):
565
356
for file_id in self.basis_inv:
566
357
if file_id not in self.new_inv:
567
self.reporter.deleted(self.basis_inv.id2path(file_id))
569
def _gen_revision_id(config, when):
358
note('deleted %s', self.basis_inv.id2path(file_id))
361
def _commit_file(self, new_ie, file_id, file_parents):
362
mutter('store new text for {%s} in revision {%s}',
363
file_id, self.rev_id)
364
new_lines = self.work_tree.get_file(file_id).readlines()
365
self._add_text_to_weave(file_id, new_lines, file_parents)
366
new_ie.text_version = self.rev_id
367
new_ie.text_sha1 = sha_strings(new_lines)
368
new_ie.text_size = sum(map(len, new_lines))
369
self.new_inv.add(new_ie)
372
def _add_text_to_weave(self, file_id, new_lines, parents):
373
if file_id.startswith('__'):
374
raise ValueError('illegal file-id %r for text file' % file_id)
375
self.weave_store.add_text(file_id, self.rev_id, new_lines, parents)
378
def _gen_revision_id(branch, when):
570
379
"""Return new revision-id."""
571
s = '%s-%s-' % (config.user_email(), compact_date(when))
380
s = '%s-%s-' % (user_email(branch), compact_date(when))
572
381
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
