← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-08-16 00:09:54 UTC
  • mfrom: (3629.1.4 uncommit_ids)
  • Revision ID: pqm@pqm.ubuntu.com-20080816000954-t0401ff8s3ydnkr6
(jam) bzr uncommit now gives the revision id to restore the branch to
        the old tip.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
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
12
12
#
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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
# The newly committed revision is going to have a shape corresponding
49
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
50
# the rest of the code; add a deprecation of the old name.
51
51
 
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
52
59
from bzrlib import (
53
60
    debug,
54
61
    errors,
55
 
    trace,
 
62
    revision,
56
63
    tree,
57
 
    ui,
58
64
    )
59
65
from bzrlib.branch import Branch
60
 
from bzrlib.cleanup import OperationWithCleanups
61
66
import bzrlib.config
62
67
from bzrlib.errors import (BzrError, PointlessCommit,
63
68
                           ConflictsInTree,
64
69
                           StrictCommitFailed
65
70
                           )
66
 
from bzrlib.osutils import (get_user_encoding,
67
 
                            is_inside_any,
 
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
 
72
                            is_inside_or_parent_of_any,
68
73
                            minimum_path_selection,
 
74
                            quotefn, sha_file, split_lines,
69
75
                            splitpath,
70
76
                            )
71
 
from bzrlib.trace import mutter, note, is_quiet
72
 
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
77
from bzrlib.testament import Testament
 
78
from bzrlib.trace import mutter, note, warning, is_quiet
 
79
from bzrlib.xml5 import serializer_v5
 
80
from bzrlib.inventory import InventoryEntry, make_entry
73
81
from bzrlib import symbol_versioning
 
82
from bzrlib.symbol_versioning import (deprecated_passed,
 
83
        deprecated_function,
 
84
        DEPRECATED_PARAMETER)
 
85
from bzrlib.workingtree import WorkingTree
74
86
from bzrlib.urlutils import unescape_for_display
 
87
import bzrlib.ui
75
88
 
76
89
 
77
90
class NullCommitReporter(object):
90
103
    def completed(self, revno, rev_id):
91
104
        pass
92
105
 
93
 
    def deleted(self, path):
 
106
    def deleted(self, file_id):
 
107
        pass
 
108
 
 
109
    def escaped(self, escape_count, message):
94
110
        pass
95
111
 
96
112
    def missing(self, path):
113
129
        note(format, *args)
114
130
 
115
131
    def snapshot_change(self, change, path):
116
 
        if path == '' and change in ('added', 'modified'):
 
132
        if change == 'unchanged':
 
133
            return
 
134
        if change == 'added' and path == '':
117
135
            return
118
136
        self._note("%s %s", change, path)
119
137
 
131
149
 
132
150
    def completed(self, revno, rev_id):
133
151
        self._note('Committed revision %d.', revno)
134
 
        # self._note goes to the console too; so while we want to log the
135
 
        # rev_id, we can't trivially only log it. (See bug 526425). Long
136
 
        # term we should rearrange the reporting structure, but for now
137
 
        # we just mutter seperately. We mutter the revid and revno together
138
 
        # so that concurrent bzr invocations won't lead to confusion.
139
 
        mutter('Committed revid %s as revno %d.', rev_id, revno)
140
 
 
141
 
    def deleted(self, path):
142
 
        self._note('deleted %s', path)
 
152
 
 
153
    def deleted(self, file_id):
 
154
        self._note('deleted %s', file_id)
 
155
 
 
156
    def escaped(self, escape_count, message):
 
157
        self._note("replaced %d control characters in message", escape_count)
143
158
 
144
159
    def missing(self, path):
145
160
        self._note('missing %s', path)
173
188
        self.reporter = reporter
174
189
        self.config = config
175
190
 
176
 
    @staticmethod
177
 
    def update_revprops(revprops, branch, authors=None, author=None,
178
 
                        local=False, possible_master_transports=None):
179
 
        if revprops is None:
180
 
            revprops = {}
181
 
        if possible_master_transports is None:
182
 
            possible_master_transports = []
183
 
        if not 'branch-nick' in revprops:
184
 
            revprops['branch-nick'] = branch._get_nick(
185
 
                local,
186
 
                possible_master_transports)
187
 
        if authors is not None:
188
 
            if author is not None:
189
 
                raise AssertionError('Specifying both author and authors '
190
 
                        'is not allowed. Specify just authors instead')
191
 
            if 'author' in revprops or 'authors' in revprops:
192
 
                # XXX: maybe we should just accept one of them?
193
 
                raise AssertionError('author property given twice')
194
 
            if authors:
195
 
                for individual in authors:
196
 
                    if '\n' in individual:
197
 
                        raise AssertionError('\\n is not a valid character '
198
 
                                'in an author identity')
199
 
                revprops['authors'] = '\n'.join(authors)
200
 
        if author is not None:
201
 
            symbol_versioning.warn('The parameter author was deprecated'
202
 
                   ' in version 1.13. Use authors instead',
203
 
                   DeprecationWarning)
204
 
            if 'author' in revprops or 'authors' in revprops:
205
 
                # XXX: maybe we should just accept one of them?
206
 
                raise AssertionError('author property given twice')
207
 
            if '\n' in author:
208
 
                raise AssertionError('\\n is not a valid character '
209
 
                        'in an author identity')
210
 
            revprops['authors'] = author
211
 
        return revprops
212
 
 
213
191
    def commit(self,
214
192
               message=None,
215
193
               timestamp=None,
227
205
               config=None,
228
206
               message_callback=None,
229
207
               recursive='down',
230
 
               exclude=None,
231
 
               possible_master_transports=None,
232
 
               lossy=False):
 
208
               exclude=None):
233
209
        """Commit working copy as a new revision.
234
210
 
235
211
        :param message: the commit message (it or message_callback is required)
236
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
237
212
 
238
213
        :param timestamp: if not None, seconds-since-epoch for a
239
214
            postdated/predated commit.
240
215
 
241
 
        :param specific_files: If not None, commit only those files. An empty
242
 
            list means 'commit no files'.
 
216
        :param specific_files: If true, commit only those files.
243
217
 
244
218
        :param rev_id: If set, use this as the new revision id.
245
219
            Useful for test or import commands that need to tightly
261
235
            pending changes of any sort during this commit.
262
236
        :param exclude: None or a list of relative paths to exclude from the
263
237
            commit. Pending changes to excluded files will be ignored by the
264
 
            commit.
265
 
        :param lossy: When committing to a foreign VCS, ignore any
266
 
            data that can not be natively represented.
 
238
            commit. 
267
239
        """
268
 
        operation = OperationWithCleanups(self._commit)
269
 
        self.revprops = revprops or {}
270
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
271
 
        self.config = config or self.config
272
 
        return operation.run(
273
 
               message=message,
274
 
               timestamp=timestamp,
275
 
               timezone=timezone,
276
 
               committer=committer,
277
 
               specific_files=specific_files,
278
 
               rev_id=rev_id,
279
 
               allow_pointless=allow_pointless,
280
 
               strict=strict,
281
 
               verbose=verbose,
282
 
               working_tree=working_tree,
283
 
               local=local,
284
 
               reporter=reporter,
285
 
               message_callback=message_callback,
286
 
               recursive=recursive,
287
 
               exclude=exclude,
288
 
               possible_master_transports=possible_master_transports,
289
 
               lossy=lossy)
290
 
 
291
 
    def _commit(self, operation, message, timestamp, timezone, committer,
292
 
            specific_files, rev_id, allow_pointless, strict, verbose,
293
 
            working_tree, local, reporter, message_callback, recursive,
294
 
            exclude, possible_master_transports, lossy):
295
240
        mutter('preparing to commit')
296
241
 
297
242
        if working_tree is None:
305
250
        if message_callback is None:
306
251
            if message is not None:
307
252
                if isinstance(message, str):
308
 
                    message = message.decode(get_user_encoding())
 
253
                    message = message.decode(bzrlib.user_encoding)
309
254
                message_callback = lambda x: message
310
255
            else:
311
256
                raise BzrError("The message or message_callback keyword"
312
257
                               " parameter is required for commit().")
313
258
 
314
259
        self.bound_branch = None
 
260
        self.any_entries_changed = False
315
261
        self.any_entries_deleted = False
316
262
        if exclude is not None:
317
263
            self.exclude = sorted(
320
266
            self.exclude = []
321
267
        self.local = local
322
268
        self.master_branch = None
 
269
        self.master_locked = False
323
270
        self.recursive = recursive
324
271
        self.rev_id = None
325
 
        # self.specific_files is None to indicate no filter, or any iterable to
326
 
        # indicate a filter - [] means no files at all, as per iter_changes.
327
272
        if specific_files is not None:
328
273
            self.specific_files = sorted(
329
274
                minimum_path_selection(specific_files))
330
275
        else:
331
276
            self.specific_files = None
332
 
 
 
277
        self.specific_file_ids = None
333
278
        self.allow_pointless = allow_pointless
 
279
        self.revprops = revprops
334
280
        self.message_callback = message_callback
335
281
        self.timestamp = timestamp
336
282
        self.timezone = timezone
337
283
        self.committer = committer
338
284
        self.strict = strict
339
285
        self.verbose = verbose
 
286
        # accumulates an inventory delta to the basis entry, so we can make
 
287
        # just the necessary updates to the workingtree's cached basis.
 
288
        self._basis_delta = []
340
289
 
341
290
        self.work_tree.lock_write()
342
 
        operation.add_cleanup(self.work_tree.unlock)
343
 
        self.parents = self.work_tree.get_parent_ids()
344
 
        # We can use record_iter_changes IFF iter_changes is compatible with
345
 
        # the command line parameters, and the repository has fast delta
346
 
        # generation. See bug 347649.
347
 
        self.use_record_iter_changes = (
348
 
            not self.exclude and 
349
 
            not self.branch.repository._format.supports_tree_reference and
350
 
            (self.branch.repository._format.fast_deltas or
351
 
             len(self.parents) < 2))
352
 
        self.pb = ui.ui_factory.nested_progress_bar()
353
 
        operation.add_cleanup(self.pb.finished)
 
291
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
354
292
        self.basis_revid = self.work_tree.last_revision()
355
293
        self.basis_tree = self.work_tree.basis_tree()
356
294
        self.basis_tree.lock_read()
357
 
        operation.add_cleanup(self.basis_tree.unlock)
358
 
        # Cannot commit with conflicts present.
359
 
        if len(self.work_tree.conflicts()) > 0:
360
 
            raise ConflictsInTree
361
 
 
362
 
        # Setup the bound branch variables as needed.
363
 
        self._check_bound_branch(operation, possible_master_transports)
364
 
 
365
 
        # Check that the working tree is up to date
366
 
        old_revno, new_revno = self._check_out_of_date_tree()
367
 
 
368
 
        # Complete configuration setup
369
 
        if reporter is not None:
370
 
            self.reporter = reporter
371
 
        elif self.reporter is None:
372
 
            self.reporter = self._select_reporter()
373
 
        if self.config is None:
374
 
            self.config = self.branch.get_config()
375
 
 
376
 
        self._set_specific_file_ids()
377
 
 
378
 
        # Setup the progress bar. As the number of files that need to be
379
 
        # committed in unknown, progress is reported as stages.
380
 
        # We keep track of entries separately though and include that
381
 
        # information in the progress bar during the relevant stages.
382
 
        self.pb_stage_name = ""
383
 
        self.pb_stage_count = 0
384
 
        self.pb_stage_total = 5
385
 
        if self.bound_branch:
386
 
            # 2 extra stages: "Uploading data to master branch" and "Merging
387
 
            # tags to master branch"
388
 
            self.pb_stage_total += 2
389
 
        self.pb.show_pct = False
390
 
        self.pb.show_spinner = False
391
 
        self.pb.show_eta = False
392
 
        self.pb.show_count = True
393
 
        self.pb.show_bar = True
394
 
 
395
 
        self._gather_parents()
396
 
        # After a merge, a selected file commit is not supported.
397
 
        # See 'bzr help merge' for an explanation as to why.
398
 
        if len(self.parents) > 1 and self.specific_files is not None:
399
 
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
400
 
        # Excludes are a form of selected file commit.
401
 
        if len(self.parents) > 1 and self.exclude:
402
 
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
403
 
 
404
 
        # Collect the changes
405
 
        self._set_progress_stage("Collecting changes", counter=True)
406
 
        self._lossy = lossy
407
 
        self.builder = self.branch.get_commit_builder(self.parents,
408
 
            self.config, timestamp, timezone, committer, self.revprops,
409
 
            rev_id, lossy=lossy)
410
 
        if not self.builder.supports_record_entry_contents and self.exclude:
411
 
            self.builder.abort()
412
 
            raise errors.ExcludesUnsupported(self.branch.repository)
413
 
 
414
295
        try:
415
 
            self.builder.will_record_deletes()
416
 
            # find the location being committed to
417
 
            if self.bound_branch:
418
 
                master_location = self.master_branch.base
419
 
            else:
420
 
                master_location = self.branch.base
421
 
 
422
 
            # report the start of the commit
423
 
            self.reporter.started(new_revno, self.rev_id, master_location)
424
 
 
425
 
            self._update_builder_with_changes()
426
 
            self._check_pointless()
427
 
 
428
 
            # TODO: Now the new inventory is known, check for conflicts.
429
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
430
 
            # weave lines, because nothing should be recorded until it is known
431
 
            # that commit will succeed.
432
 
            self._set_progress_stage("Saving data locally")
433
 
            self.builder.finish_inventory()
434
 
 
435
 
            # Prompt the user for a commit message if none provided
436
 
            message = message_callback(self)
437
 
            self.message = message
438
 
 
439
 
            # Add revision data to the local branch
440
 
            self.rev_id = self.builder.commit(self.message)
441
 
 
442
 
        except Exception, e:
443
 
            mutter("aborting commit write group because of exception:")
444
 
            trace.log_exception_quietly()
445
 
            self.builder.abort()
446
 
            raise
447
 
 
448
 
        self._process_pre_hooks(old_revno, new_revno)
449
 
 
450
 
        # Upload revision data to the master.
451
 
        # this will propagate merged revisions too if needed.
452
 
        if self.bound_branch:
453
 
            self._set_progress_stage("Uploading data to master branch")
454
 
            # 'commit' to the master first so a timeout here causes the
455
 
            # local branch to be out of date
456
 
            (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
457
 
                self.branch, new_revno, self.rev_id, lossy=lossy)
458
 
            if lossy:
459
 
                self.branch.fetch(self.master_branch, self.rev_id)
460
 
 
461
 
        # and now do the commit locally.
462
 
        self.branch.set_last_revision_info(new_revno, self.rev_id)
463
 
 
464
 
        # Merge local tags to remote
465
 
        if self.bound_branch:
466
 
            self._set_progress_stage("Merging tags to master branch")
467
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
468
 
                self.master_branch.tags)
469
 
            if tag_conflicts:
470
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
471
 
                note("Conflicting tags in bound branch:\n" +
472
 
                    "\n".join(warning_lines))
473
 
 
474
 
        # Make the working tree be up to date with the branch. This
475
 
        # includes automatic changes scheduled to be made to the tree, such
476
 
        # as updating its basis and unversioning paths that were missing.
477
 
        self.work_tree.unversion(self.deleted_ids)
478
 
        self._set_progress_stage("Updating the working tree")
479
 
        self.work_tree.update_basis_by_delta(self.rev_id,
480
 
             self.builder.get_basis_delta())
481
 
        self.reporter.completed(new_revno, self.rev_id)
482
 
        self._process_post_hooks(old_revno, new_revno)
 
296
            # Cannot commit with conflicts present.
 
297
            if len(self.work_tree.conflicts()) > 0:
 
298
                raise ConflictsInTree
 
299
 
 
300
            # Setup the bound branch variables as needed.
 
301
            self._check_bound_branch()
 
302
 
 
303
            # Check that the working tree is up to date
 
304
            old_revno, new_revno = self._check_out_of_date_tree()
 
305
 
 
306
            # Complete configuration setup
 
307
            if reporter is not None:
 
308
                self.reporter = reporter
 
309
            elif self.reporter is None:
 
310
                self.reporter = self._select_reporter()
 
311
            if self.config is None:
 
312
                self.config = self.branch.get_config()
 
313
 
 
314
            # If provided, ensure the specified files are versioned
 
315
            if self.specific_files is not None:
 
316
                # Note: This routine is being called because it raises
 
317
                # PathNotVersionedError as a side effect of finding the IDs. We
 
318
                # later use the ids we found as input to the working tree
 
319
                # inventory iterator, so we only consider those ids rather than
 
320
                # examining the whole tree again.
 
321
                # XXX: Dont we have filter_unversioned to do this more
 
322
                # cheaply?
 
323
                self.specific_file_ids = tree.find_ids_across_trees(
 
324
                    specific_files, [self.basis_tree, self.work_tree])
 
325
 
 
326
            # Setup the progress bar. As the number of files that need to be
 
327
            # committed in unknown, progress is reported as stages.
 
328
            # We keep track of entries separately though and include that
 
329
            # information in the progress bar during the relevant stages.
 
330
            self.pb_stage_name = ""
 
331
            self.pb_stage_count = 0
 
332
            self.pb_stage_total = 5
 
333
            if self.bound_branch:
 
334
                self.pb_stage_total += 1
 
335
            self.pb.show_pct = False
 
336
            self.pb.show_spinner = False
 
337
            self.pb.show_eta = False
 
338
            self.pb.show_count = True
 
339
            self.pb.show_bar = True
 
340
 
 
341
            self.basis_inv = self.basis_tree.inventory
 
342
            self._gather_parents()
 
343
            # After a merge, a selected file commit is not supported.
 
344
            # See 'bzr help merge' for an explanation as to why.
 
345
            if len(self.parents) > 1 and self.specific_files:
 
346
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
347
            # Excludes are a form of selected file commit.
 
348
            if len(self.parents) > 1 and self.exclude:
 
349
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
350
 
 
351
            # Collect the changes
 
352
            self._set_progress_stage("Collecting changes",
 
353
                    entries_title="Directory")
 
354
            self.builder = self.branch.get_commit_builder(self.parents,
 
355
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
356
            
 
357
            try:
 
358
                # find the location being committed to
 
359
                if self.bound_branch:
 
360
                    master_location = self.master_branch.base
 
361
                else:
 
362
                    master_location = self.branch.base
 
363
 
 
364
                # report the start of the commit
 
365
                self.reporter.started(new_revno, self.rev_id, master_location)
 
366
 
 
367
                self._update_builder_with_changes()
 
368
                self._report_and_accumulate_deletes()
 
369
                self._check_pointless()
 
370
 
 
371
                # TODO: Now the new inventory is known, check for conflicts.
 
372
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
373
                # weave lines, because nothing should be recorded until it is known
 
374
                # that commit will succeed.
 
375
                self._set_progress_stage("Saving data locally")
 
376
                self.builder.finish_inventory()
 
377
 
 
378
                # Prompt the user for a commit message if none provided
 
379
                message = message_callback(self)
 
380
                self.message = message
 
381
                self._escape_commit_message()
 
382
 
 
383
                # Add revision data to the local branch
 
384
                self.rev_id = self.builder.commit(self.message)
 
385
 
 
386
            except:
 
387
                self.builder.abort()
 
388
                raise
 
389
 
 
390
            self._process_pre_hooks(old_revno, new_revno)
 
391
 
 
392
            # Upload revision data to the master.
 
393
            # this will propagate merged revisions too if needed.
 
394
            if self.bound_branch:
 
395
                if not self.master_branch.repository.has_same_location(
 
396
                        self.branch.repository):
 
397
                    self._set_progress_stage("Uploading data to master branch")
 
398
                    self.master_branch.repository.fetch(self.branch.repository,
 
399
                        revision_id=self.rev_id)
 
400
                # now the master has the revision data
 
401
                # 'commit' to the master first so a timeout here causes the
 
402
                # local branch to be out of date
 
403
                self.master_branch.set_last_revision_info(new_revno,
 
404
                                                          self.rev_id)
 
405
 
 
406
            # and now do the commit locally.
 
407
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
408
 
 
409
            # Make the working tree up to date with the branch
 
410
            self._set_progress_stage("Updating the working tree")
 
411
            self.work_tree.update_basis_by_delta(self.rev_id,
 
412
                 self._basis_delta)
 
413
            self.reporter.completed(new_revno, self.rev_id)
 
414
            self._process_post_hooks(old_revno, new_revno)
 
415
        finally:
 
416
            self._cleanup()
483
417
        return self.rev_id
484
418
 
485
419
    def _select_reporter(self):
494
428
        # A merge with no effect on files
495
429
        if len(self.parents) > 1:
496
430
            return
497
 
        if self.builder.any_changes():
 
431
        # TODO: we could simplify this by using self._basis_delta.
 
432
 
 
433
        # The initial commit adds a root directory, but this in itself is not
 
434
        # a worthwhile commit.
 
435
        if (self.basis_revid == revision.NULL_REVISION and
 
436
            len(self.builder.new_inventory) == 1):
 
437
            raise PointlessCommit()
 
438
        # If length == 1, then we only have the root entry. Which means
 
439
        # that there is no real difference (only the root could be different)
 
440
        # unless deletes occured, in which case the length is irrelevant.
 
441
        if (self.any_entries_deleted or 
 
442
            (len(self.builder.new_inventory) != 1 and
 
443
             self.any_entries_changed)):
498
444
            return
499
445
        raise PointlessCommit()
500
446
 
501
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
447
    def _check_bound_branch(self):
502
448
        """Check to see if the local branch is bound.
503
449
 
504
450
        If it is bound, then most of the commit will actually be
509
455
            raise errors.LocalRequiresBoundBranch()
510
456
 
511
457
        if not self.local:
512
 
            self.master_branch = self.branch.get_master_branch(
513
 
                possible_master_transports)
 
458
            self.master_branch = self.branch.get_master_branch()
514
459
 
515
460
        if not self.master_branch:
516
461
            # make this branch the reference branch for out of date checks.
527
472
        #       commits to the remote branch if they would fit.
528
473
        #       But for now, just require remote to be identical
529
474
        #       to local.
530
 
 
 
475
        
531
476
        # Make sure the local branch is identical to the master
532
477
        master_info = self.master_branch.last_revision_info()
533
478
        local_info = self.branch.last_revision_info()
539
484
        # so grab the lock
540
485
        self.bound_branch = self.branch
541
486
        self.master_branch.lock_write()
542
 
        operation.add_cleanup(self.master_branch.unlock)
 
487
        self.master_locked = True
543
488
 
544
489
    def _check_out_of_date_tree(self):
545
490
        """Check that the working tree is up to date.
590
535
    def _process_hooks(self, hook_name, old_revno, new_revno):
591
536
        if not Branch.hooks[hook_name]:
592
537
            return
593
 
 
 
538
        
594
539
        # new style commit hooks:
595
540
        if not self.bound_branch:
596
541
            hook_master = self.branch
605
550
            old_revid = self.parents[0]
606
551
        else:
607
552
            old_revid = bzrlib.revision.NULL_REVISION
608
 
 
 
553
        
609
554
        if hook_name == "pre_commit":
610
555
            future_tree = self.builder.revision_tree()
611
556
            tree_delta = future_tree.changes_from(self.basis_tree,
612
557
                                             include_root=True)
613
 
 
 
558
        
614
559
        for hook in Branch.hooks[hook_name]:
615
560
            # show the running hook in the progress bar. As hooks may
616
561
            # end up doing nothing (e.g. because they are not configured by
630
575
                     old_revno, old_revid, new_revno, self.rev_id,
631
576
                     tree_delta, future_tree)
632
577
 
 
578
    def _cleanup(self):
 
579
        """Cleanup any open locks, progress bars etc."""
 
580
        cleanups = [self._cleanup_bound_branch,
 
581
                    self.basis_tree.unlock,
 
582
                    self.work_tree.unlock,
 
583
                    self.pb.finished]
 
584
        found_exception = None
 
585
        for cleanup in cleanups:
 
586
            try:
 
587
                cleanup()
 
588
            # we want every cleanup to run no matter what.
 
589
            # so we have a catchall here, but we will raise the
 
590
            # last encountered exception up the stack: and
 
591
            # typically this will be useful enough.
 
592
            except Exception, e:
 
593
                found_exception = e
 
594
        if found_exception is not None: 
 
595
            # don't do a plan raise, because the last exception may have been
 
596
            # trashed, e is our sure-to-work exception even though it loses the
 
597
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
598
            # exc_info and if its the same one do a plain raise otherwise 
 
599
            # 'raise e' as we do now.
 
600
            raise e
 
601
 
 
602
    def _cleanup_bound_branch(self):
 
603
        """Executed at the end of a try/finally to cleanup a bound branch.
 
604
 
 
605
        If the branch wasn't bound, this is a no-op.
 
606
        If it was, it resents self.branch to the local branch, instead
 
607
        of being the master.
 
608
        """
 
609
        if not self.bound_branch:
 
610
            return
 
611
        if self.master_locked:
 
612
            self.master_branch.unlock()
 
613
 
 
614
    def _escape_commit_message(self):
 
615
        """Replace xml-incompatible control characters."""
 
616
        # FIXME: RBC 20060419 this should be done by the revision
 
617
        # serialiser not by commit. Then we can also add an unescaper
 
618
        # in the deserializer and start roundtripping revision messages
 
619
        # precisely. See repository_implementations/test_repository.py
 
620
        
 
621
        # Python strings can include characters that can't be
 
622
        # represented in well-formed XML; escape characters that
 
623
        # aren't listed in the XML specification
 
624
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
625
        self.message, escape_count = re.subn(
 
626
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
627
            lambda match: match.group(0).encode('unicode_escape'),
 
628
            self.message)
 
629
        if escape_count:
 
630
            self.reporter.escaped(escape_count, self.message)
 
631
 
633
632
    def _gather_parents(self):
634
633
        """Record the parents of a merge for merge detection."""
635
 
        # TODO: Make sure that this list doesn't contain duplicate
 
634
        # TODO: Make sure that this list doesn't contain duplicate 
636
635
        # entries and the order is preserved when doing this.
637
 
        if self.use_record_iter_changes:
638
 
            return
639
 
        self.basis_inv = self.basis_tree.inventory
 
636
        self.parents = self.work_tree.get_parent_ids()
640
637
        self.parent_invs = [self.basis_inv]
641
638
        for revision in self.parents[1:]:
642
639
            if self.branch.repository.has_revision(revision):
649
646
    def _update_builder_with_changes(self):
650
647
        """Update the commit builder with the data about what has changed.
651
648
        """
 
649
        # Build the revision inventory.
 
650
        #
 
651
        # This starts by creating a new empty inventory. Depending on
 
652
        # which files are selected for commit, and what is present in the
 
653
        # current tree, the new inventory is populated. inventory entries 
 
654
        # which are candidates for modification have their revision set to
 
655
        # None; inventory entries that are carried over untouched have their
 
656
        # revision set to their prior value.
 
657
        #
 
658
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
659
        # results to create a new inventory at the same time, which results
 
660
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
661
        # ADHB 11-07-2006
 
662
 
652
663
        exclude = self.exclude
653
 
        specific_files = self.specific_files
 
664
        specific_files = self.specific_files or []
654
665
        mutter("Selecting files for commit with filter %s", specific_files)
655
666
 
656
 
        self._check_strict()
657
 
        if self.use_record_iter_changes:
658
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
659
 
                specific_files=specific_files)
660
 
            iter_changes = self._filter_iter_changes(iter_changes)
661
 
            for file_id, path, fs_hash in self.builder.record_iter_changes(
662
 
                self.work_tree, self.basis_revid, iter_changes):
663
 
                self.work_tree._observed_sha1(file_id, path, fs_hash)
664
 
        else:
665
 
            # Build the new inventory
666
 
            self._populate_from_inventory()
667
 
            self._record_unselected()
668
 
            self._report_and_accumulate_deletes()
669
 
 
670
 
    def _filter_iter_changes(self, iter_changes):
671
 
        """Process iter_changes.
672
 
 
673
 
        This method reports on the changes in iter_changes to the user, and 
674
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
675
 
        entries. 'missing' entries have their
676
 
 
677
 
        :param iter_changes: An iter_changes to process.
678
 
        :return: A generator of changes.
679
 
        """
680
 
        reporter = self.reporter
681
 
        report_changes = reporter.is_verbose()
682
 
        deleted_ids = []
683
 
        for change in iter_changes:
684
 
            if report_changes:
685
 
                old_path = change[1][0]
686
 
                new_path = change[1][1]
687
 
                versioned = change[3][1]
688
 
            kind = change[6][1]
689
 
            versioned = change[3][1]
690
 
            if kind is None and versioned:
691
 
                # 'missing' path
692
 
                if report_changes:
693
 
                    reporter.missing(new_path)
694
 
                deleted_ids.append(change[0])
695
 
                # Reset the new path (None) and new versioned flag (False)
696
 
                change = (change[0], (change[1][0], None), change[2],
697
 
                    (change[3][0], False)) + change[4:]
698
 
                new_path = change[1][1]
699
 
                versioned = False
700
 
            elif kind == 'tree-reference':
701
 
                if self.recursive == 'down':
702
 
                    self._commit_nested_tree(change[0], change[1][1])
703
 
            if change[3][0] or change[3][1]:
704
 
                yield change
705
 
                if report_changes:
706
 
                    if new_path is None:
707
 
                        reporter.deleted(old_path)
708
 
                    elif old_path is None:
709
 
                        reporter.snapshot_change('added', new_path)
710
 
                    elif old_path != new_path:
711
 
                        reporter.renamed('renamed', old_path, new_path)
712
 
                    else:
713
 
                        if (new_path or 
714
 
                            self.work_tree.branch.repository._format.rich_root_data):
715
 
                            # Don't report on changes to '' in non rich root
716
 
                            # repositories.
717
 
                            reporter.snapshot_change('modified', new_path)
718
 
            self._next_progress_entry()
719
 
        # Unversion IDs that were found to be deleted
720
 
        self.deleted_ids = deleted_ids
721
 
 
722
 
    def _record_unselected(self):
 
667
        # Build the new inventory
 
668
        self._populate_from_inventory()
 
669
 
723
670
        # If specific files are selected, then all un-selected files must be
724
671
        # recorded in their previous state. For more details, see
725
672
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
726
 
        if self.specific_files or self.exclude:
727
 
            specific_files = self.specific_files or []
 
673
        if specific_files or exclude:
728
674
            for path, old_ie in self.basis_inv.iter_entries():
729
 
                if self.builder.new_inventory.has_id(old_ie.file_id):
 
675
                if old_ie.file_id in self.builder.new_inventory:
730
676
                    # already added - skip.
731
677
                    continue
732
678
                if (is_inside_any(specific_files, path)
733
 
                    and not is_inside_any(self.exclude, path)):
 
679
                    and not is_inside_any(exclude, path)):
734
680
                    # was inside the selected path, and not excluded - if not
735
681
                    # present it has been deleted so skip.
736
682
                    continue
737
683
                # From here down it was either not selected, or was excluded:
 
684
                if old_ie.kind == 'directory':
 
685
                    self._next_progress_entry()
738
686
                # We preserve the entry unaltered.
739
687
                ie = old_ie.copy()
740
688
                # Note: specific file commits after a merge are currently
742
690
                # required after that changes.
743
691
                if len(self.parents) > 1:
744
692
                    ie.revision = None
745
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
746
 
                    self.basis_tree, None)
 
693
                delta, version_recorded = self.builder.record_entry_contents(
 
694
                    ie, self.parent_invs, path, self.basis_tree, None)
 
695
                if version_recorded:
 
696
                    self.any_entries_changed = True
 
697
                if delta: self._basis_delta.append(delta)
747
698
 
748
699
    def _report_and_accumulate_deletes(self):
749
 
        if (isinstance(self.basis_inv, Inventory)
750
 
            and isinstance(self.builder.new_inventory, Inventory)):
751
 
            # the older Inventory classes provide a _byid dict, and building a
752
 
            # set from the keys of this dict is substantially faster than even
753
 
            # getting a set of ids from the inventory
754
 
            #
755
 
            # <lifeless> set(dict) is roughly the same speed as
756
 
            # set(iter(dict)) and both are significantly slower than
757
 
            # set(dict.keys())
758
 
            deleted_ids = set(self.basis_inv._byid.keys()) - \
759
 
               set(self.builder.new_inventory._byid.keys())
760
 
        else:
761
 
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
700
        # XXX: Could the list of deleted paths and ids be instead taken from
 
701
        # _populate_from_inventory?
 
702
        deleted_ids = set(self.basis_inv._byid.keys()) - \
 
703
            set(self.builder.new_inventory._byid.keys())
762
704
        if deleted_ids:
763
705
            self.any_entries_deleted = True
764
706
            deleted = [(self.basis_tree.id2path(file_id), file_id)
766
708
            deleted.sort()
767
709
            # XXX: this is not quite directory-order sorting
768
710
            for path, file_id in deleted:
769
 
                self.builder.record_delete(path, file_id)
 
711
                self._basis_delta.append((path, None, file_id, None))
770
712
                self.reporter.deleted(path)
771
713
 
772
 
    def _check_strict(self):
773
 
        # XXX: when we use iter_changes this would likely be faster if
774
 
        # iter_changes would check for us (even in the presence of
775
 
        # selected_files).
 
714
    def _populate_from_inventory(self):
 
715
        """Populate the CommitBuilder by walking the working tree inventory."""
776
716
        if self.strict:
777
717
            # raise an exception as soon as we find a single unknown.
778
718
            for unknown in self.work_tree.unknowns():
779
719
                raise StrictCommitFailed()
780
 
 
781
 
    def _populate_from_inventory(self):
782
 
        """Populate the CommitBuilder by walking the working tree inventory."""
783
 
        # Build the revision inventory.
784
 
        #
785
 
        # This starts by creating a new empty inventory. Depending on
786
 
        # which files are selected for commit, and what is present in the
787
 
        # current tree, the new inventory is populated. inventory entries
788
 
        # which are candidates for modification have their revision set to
789
 
        # None; inventory entries that are carried over untouched have their
790
 
        # revision set to their prior value.
791
 
        #
792
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
793
 
        # results to create a new inventory at the same time, which results
794
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
795
 
        # ADHB 11-07-2006
796
 
 
 
720
        
797
721
        specific_files = self.specific_files
798
722
        exclude = self.exclude
799
723
        report_changes = self.reporter.is_verbose()
813
737
            name = existing_ie.name
814
738
            parent_id = existing_ie.parent_id
815
739
            kind = existing_ie.kind
 
740
            if kind == 'directory':
 
741
                self._next_progress_entry()
816
742
            # Skip files that have been deleted from the working tree.
817
743
            # The deleted path ids are also recorded so they can be explicitly
818
744
            # unversioned later.
836
762
                # _update_builder_with_changes.
837
763
                continue
838
764
            content_summary = self.work_tree.path_content_summary(path)
839
 
            kind = content_summary[0]
840
765
            # Note that when a filter of specific files is given, we must only
841
766
            # skip/record deleted files matching that filter.
842
767
            if not specific_files or is_inside_any(specific_files, path):
843
 
                if kind == 'missing':
 
768
                if content_summary[0] == 'missing':
844
769
                    if not deleted_paths:
845
770
                        # path won't have been split yet.
846
771
                        path_segments = splitpath(path)
848
773
                    for segment in path_segments:
849
774
                        deleted_dict = deleted_dict.setdefault(segment, {})
850
775
                    self.reporter.missing(path)
851
 
                    self._next_progress_entry()
852
776
                    deleted_ids.append(file_id)
853
777
                    continue
854
778
            # TODO: have the builder do the nested commit just-in-time IF and
855
779
            # only if needed.
856
 
            if kind == 'tree-reference':
 
780
            if content_summary[0] == 'tree-reference':
857
781
                # enforce repository nested tree policy.
858
782
                if (not self.work_tree.supports_tree_reference() or
859
783
                    # repository does not support it either.
860
784
                    not self.branch.repository._format.supports_tree_reference):
861
 
                    kind = 'directory'
862
 
                    content_summary = (kind, None, None, None)
863
 
                elif self.recursive == 'down':
 
785
                    content_summary = ('directory',) + content_summary[1:]
 
786
            kind = content_summary[0]
 
787
            # TODO: specific_files filtering before nested tree processing
 
788
            if kind == 'tree-reference':
 
789
                if self.recursive == 'down':
864
790
                    nested_revision_id = self._commit_nested_tree(
865
791
                        file_id, path)
866
 
                    content_summary = (kind, None, None, nested_revision_id)
 
792
                    content_summary = content_summary[:3] + (
 
793
                        nested_revision_id,)
867
794
                else:
868
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
869
 
                    content_summary = (kind, None, None, nested_revision_id)
 
795
                    content_summary = content_summary[:3] + (
 
796
                        self.work_tree.get_reference_revision(file_id),)
870
797
 
871
798
            # Record an entry for this item
872
799
            # Note: I don't particularly want to have the existing_ie
878
805
                content_summary)
879
806
 
880
807
        # Unversion IDs that were found to be deleted
881
 
        self.deleted_ids = deleted_ids
 
808
        self.work_tree.unversion(deleted_ids)
882
809
 
883
810
    def _commit_nested_tree(self, file_id, path):
884
811
        "Commit a nested tree."
886
813
        # FIXME: be more comprehensive here:
887
814
        # this works when both trees are in --trees repository,
888
815
        # but when both are bound to a different repository,
889
 
        # it fails; a better way of approaching this is to
 
816
        # it fails; a better way of approaching this is to 
890
817
        # finally implement the explicit-caches approach design
891
818
        # a while back - RBC 20070306.
892
819
        if sub_tree.branch.repository.has_same_location(
916
843
        else:
917
844
            ie = existing_ie.copy()
918
845
            ie.revision = None
919
 
        # For carried over entries we don't care about the fs hash - the repo
920
 
        # isn't generating a sha, so we're not saving computation time.
921
 
        _, _, fs_hash = self.builder.record_entry_contents(
922
 
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
846
        delta, version_recorded = self.builder.record_entry_contents(ie,
 
847
            self.parent_invs, path, self.work_tree, content_summary)
 
848
        if delta:
 
849
            self._basis_delta.append(delta)
 
850
        if version_recorded:
 
851
            self.any_entries_changed = True
923
852
        if report_changes:
924
853
            self._report_change(ie, path)
925
 
        if fs_hash:
926
 
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
927
854
        return ie
928
855
 
929
856
    def _report_change(self, ie, path):
937
864
        else:
938
865
            basis_ie = None
939
866
        change = ie.describe_change(basis_ie, ie)
940
 
        if change in (InventoryEntry.RENAMED,
 
867
        if change in (InventoryEntry.RENAMED, 
941
868
            InventoryEntry.MODIFIED_AND_RENAMED):
942
869
            old_path = self.basis_inv.id2path(ie.file_id)
943
870
            self.reporter.renamed(change, old_path, path)
944
 
            self._next_progress_entry()
945
871
        else:
946
 
            if change == 'unchanged':
947
 
                return
948
872
            self.reporter.snapshot_change(change, path)
949
 
            self._next_progress_entry()
950
873
 
951
 
    def _set_progress_stage(self, name, counter=False):
 
874
    def _set_progress_stage(self, name, entries_title=None):
952
875
        """Set the progress stage and emit an update to the progress bar."""
953
876
        self.pb_stage_name = name
954
877
        self.pb_stage_count += 1
955
 
        if counter:
 
878
        self.pb_entries_title = entries_title
 
879
        if entries_title is not None:
956
880
            self.pb_entries_count = 0
957
 
        else:
958
 
            self.pb_entries_count = None
 
881
            self.pb_entries_total = '?'
959
882
        self._emit_progress()
960
883
 
961
884
    def _next_progress_entry(self):
964
887
        self._emit_progress()
965
888
 
966
889
    def _emit_progress(self):
967
 
        if self.pb_entries_count is not None:
968
 
            text = "%s [%d] - Stage" % (self.pb_stage_name,
969
 
                self.pb_entries_count)
 
890
        if self.pb_entries_title:
 
891
            if self.pb_entries_total == '?':
 
892
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
893
                    self.pb_entries_title, self.pb_entries_count)
 
894
            else:
 
895
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
896
                    self.pb_entries_title, self.pb_entries_count,
 
897
                    str(self.pb_entries_total))
970
898
        else:
971
 
            text = "%s - Stage" % (self.pb_stage_name, )
 
899
            text = "%s - Stage" % (self.pb_stage_name)
972
900
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
973
901
 
974
 
    def _set_specific_file_ids(self):
975
 
        """populate self.specific_file_ids if we will use it."""
976
 
        if not self.use_record_iter_changes:
977
 
            # If provided, ensure the specified files are versioned
978
 
            if self.specific_files is not None:
979
 
                # Note: This routine is being called because it raises
980
 
                # PathNotVersionedError as a side effect of finding the IDs. We
981
 
                # later use the ids we found as input to the working tree
982
 
                # inventory iterator, so we only consider those ids rather than
983
 
                # examining the whole tree again.
984
 
                # XXX: Dont we have filter_unversioned to do this more
985
 
                # cheaply?
986
 
                self.specific_file_ids = tree.find_ids_across_trees(
987
 
                    self.specific_files, [self.basis_tree, self.work_tree])
988
 
            else:
989
 
                self.specific_file_ids = None