← 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-09-03 20:58:40 UTC
  • mfrom: (3626.1.6 unicode_hostname)
  • Revision ID: pqm@pqm.ubuntu.com-20080903205840-mteswj8dfvld7vo3
(Mark Hammond) Fix bug #256550 by using a Unicode api on Windows for
        the host name.

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