/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Ian Clatworthy
  • Date: 2008-07-17 01:08:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3546.
  • Revision ID: ian.clatworthy@canonical.com-20080717010821-qg05ah7iobvl8hin
workaround docutils dot-in-option name bug (Mark Hammond)

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
from __future__ import absolute_import
18
17
 
19
18
# The newly committed revision is going to have a shape corresponding
20
19
# to that of the working tree.  Files that are not in the
50
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
50
# the rest of the code; add a deprecation of the old name.
52
51
 
53
 
from . import (
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
 
59
from bzrlib import (
54
60
    debug,
55
61
    errors,
56
 
    trace,
 
62
    revision,
57
63
    tree,
58
 
    ui,
59
64
    )
60
 
from .branch import Branch
61
 
from .cleanup import OperationWithCleanups
62
 
import breezy.config
63
 
from .errors import (BzrError,
64
 
                     ConflictsInTree,
65
 
                     StrictCommitFailed
66
 
                     )
67
 
from .osutils import (get_user_encoding,
68
 
                      is_inside_any,
69
 
                      minimum_path_selection,
70
 
                      splitpath,
71
 
                      )
72
 
from .trace import mutter, note, is_quiet
73
 
from .urlutils import unescape_for_display
74
 
from .i18n import gettext
75
 
 
76
 
 
77
 
class PointlessCommit(BzrError):
78
 
 
79
 
    _fmt = "No changes to commit"
80
 
 
81
 
 
82
 
class CannotCommitSelectedFileMerge(BzrError):
83
 
 
84
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
85
 
        ' files %(files_str)s'
86
 
 
87
 
    def __init__(self, files):
88
 
        files_str = ', '.join(files)
89
 
        BzrError.__init__(self, files=files, files_str=files_str)
90
 
 
91
 
 
92
 
def filter_excluded(iter_changes, exclude):
93
 
    """Filter exclude filenames.
94
 
 
95
 
    :param iter_changes: iter_changes function
96
 
    :param exclude: List of paths to exclude
97
 
    :return: iter_changes function
98
 
    """
99
 
    for change in iter_changes:
100
 
        old_path = change[1][0]
101
 
        new_path = change[1][1]
102
 
 
103
 
        new_excluded = (new_path is not None and
104
 
            is_inside_any(exclude, new_path))
105
 
 
106
 
        old_excluded = (old_path is not None and
107
 
            is_inside_any(exclude, old_path))
108
 
 
109
 
        if old_excluded and new_excluded:
110
 
            continue
111
 
 
112
 
        if old_excluded or new_excluded:
113
 
            # TODO(jelmer): Perhaps raise an error here instead?
114
 
            continue
115
 
 
116
 
        yield change
 
65
from bzrlib.branch import Branch
 
66
import bzrlib.config
 
67
from bzrlib.errors import (BzrError, PointlessCommit,
 
68
                           ConflictsInTree,
 
69
                           StrictCommitFailed
 
70
                           )
 
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
 
72
                            is_inside_or_parent_of_any,
 
73
                            minimum_path_selection,
 
74
                            quotefn, sha_file, split_lines,
 
75
                            splitpath,
 
76
                            )
 
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
 
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
 
86
from bzrlib.urlutils import unescape_for_display
 
87
import bzrlib.ui
117
88
 
118
89
 
119
90
class NullCommitReporter(object):
120
91
    """I report on progress of a commit."""
121
92
 
122
 
    def started(self, revno, revid, location):
 
93
    def started(self, revno, revid, location=None):
 
94
        if location is None:
 
95
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
96
                                   "to started.", DeprecationWarning,
 
97
                                   stacklevel=2)
123
98
        pass
124
99
 
125
100
    def snapshot_change(self, change, path):
128
103
    def completed(self, revno, rev_id):
129
104
        pass
130
105
 
131
 
    def deleted(self, path):
 
106
    def deleted(self, file_id):
 
107
        pass
 
108
 
 
109
    def escaped(self, escape_count, message):
132
110
        pass
133
111
 
134
112
    def missing(self, path):
151
129
        note(format, *args)
152
130
 
153
131
    def snapshot_change(self, change, path):
154
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
132
        if change == 'unchanged':
 
133
            return
 
134
        if change == 'added' and path == '':
155
135
            return
156
136
        self._note("%s %s", change, path)
157
137
 
158
 
    def started(self, revno, rev_id, location):
159
 
        self._note(
160
 
            gettext('Committing to: %s'),
161
 
            unescape_for_display(location, 'utf-8'))
 
138
    def started(self, revno, rev_id, location=None):
 
139
        if location is not None:
 
140
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
141
        else:
 
142
            # When started was added, location was only made optional by
 
143
            # accident.  Matt Nordhoff 20071129
 
144
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
145
                                   "to started.", DeprecationWarning,
 
146
                                   stacklevel=2)
 
147
            location = ''
 
148
        self._note('Committing%s', location)
162
149
 
163
150
    def completed(self, revno, rev_id):
164
 
        self._note(gettext('Committed revision %d.'), revno)
165
 
        # self._note goes to the console too; so while we want to log the
166
 
        # rev_id, we can't trivially only log it. (See bug 526425). Long
167
 
        # term we should rearrange the reporting structure, but for now
168
 
        # we just mutter seperately. We mutter the revid and revno together
169
 
        # so that concurrent bzr invocations won't lead to confusion.
170
 
        mutter('Committed revid %s as revno %d.', rev_id, revno)
171
 
 
172
 
    def deleted(self, path):
173
 
        self._note(gettext('deleted %s'), path)
 
151
        self._note('Committed revision %d.', revno)
 
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)
174
158
 
175
159
    def missing(self, path):
176
 
        self._note(gettext('missing %s'), path)
 
160
        self._note('missing %s', path)
177
161
 
178
162
    def renamed(self, change, old_path, new_path):
179
163
        self._note('%s %s => %s', change, old_path, new_path)
196
180
    """
197
181
    def __init__(self,
198
182
                 reporter=None,
199
 
                 config_stack=None):
 
183
                 config=None):
200
184
        """Create a Commit object.
201
185
 
202
186
        :param reporter: the default reporter to use or None to decide later
203
187
        """
204
188
        self.reporter = reporter
205
 
        self.config_stack = config_stack
206
 
 
207
 
    @staticmethod
208
 
    def update_revprops(revprops, branch, authors=None,
209
 
                        local=False, possible_master_transports=None):
210
 
        if revprops is None:
211
 
            revprops = {}
212
 
        if possible_master_transports is None:
213
 
            possible_master_transports = []
214
 
        if (not u'branch-nick' in revprops and
215
 
                branch.repository._format.supports_storing_branch_nick):
216
 
            revprops[u'branch-nick'] = branch._get_nick(
217
 
                local,
218
 
                possible_master_transports)
219
 
        if authors is not None:
220
 
            if u'author' in revprops or u'authors' in revprops:
221
 
                # XXX: maybe we should just accept one of them?
222
 
                raise AssertionError('author property given twice')
223
 
            if authors:
224
 
                for individual in authors:
225
 
                    if '\n' in individual:
226
 
                        raise AssertionError('\\n is not a valid character '
227
 
                                'in an author identity')
228
 
                revprops[u'authors'] = '\n'.join(authors)
229
 
        return revprops
 
189
        self.config = config
230
190
 
231
191
    def commit(self,
232
192
               message=None,
244
204
               reporter=None,
245
205
               config=None,
246
206
               message_callback=None,
247
 
               recursive='down',
248
 
               exclude=None,
249
 
               possible_master_transports=None,
250
 
               lossy=False):
 
207
               recursive='down'):
251
208
        """Commit working copy as a new revision.
252
209
 
253
210
        :param message: the commit message (it or message_callback is required)
254
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
255
211
 
256
212
        :param timestamp: if not None, seconds-since-epoch for a
257
213
            postdated/predated commit.
258
214
 
259
 
        :param specific_files: If not None, commit only those files. An empty
260
 
            list means 'commit no files'.
 
215
        :param specific_files: If true, commit only those files.
261
216
 
262
217
        :param rev_id: If set, use this as the new revision id.
263
218
            Useful for test or import commands that need to tightly
277
232
        :param verbose: if True and the reporter is not None, report everything
278
233
        :param recursive: If set to 'down', commit in any subtrees that have
279
234
            pending changes of any sort during this commit.
280
 
        :param exclude: None or a list of relative paths to exclude from the
281
 
            commit. Pending changes to excluded files will be ignored by the
282
 
            commit.
283
 
        :param lossy: When committing to a foreign VCS, ignore any
284
 
            data that can not be natively represented.
285
235
        """
286
 
        operation = OperationWithCleanups(self._commit)
287
 
        self.revprops = revprops or {}
288
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
 
        self.config_stack = config or self.config_stack
290
 
        return operation.run(
291
 
               message=message,
292
 
               timestamp=timestamp,
293
 
               timezone=timezone,
294
 
               committer=committer,
295
 
               specific_files=specific_files,
296
 
               rev_id=rev_id,
297
 
               allow_pointless=allow_pointless,
298
 
               strict=strict,
299
 
               verbose=verbose,
300
 
               working_tree=working_tree,
301
 
               local=local,
302
 
               reporter=reporter,
303
 
               message_callback=message_callback,
304
 
               recursive=recursive,
305
 
               exclude=exclude,
306
 
               possible_master_transports=possible_master_transports,
307
 
               lossy=lossy)
308
 
 
309
 
    def _commit(self, operation, message, timestamp, timezone, committer,
310
 
            specific_files, rev_id, allow_pointless, strict, verbose,
311
 
            working_tree, local, reporter, message_callback, recursive,
312
 
            exclude, possible_master_transports, lossy):
313
236
        mutter('preparing to commit')
314
237
 
315
238
        if working_tree is None:
322
245
                    raise errors.RootNotRich()
323
246
        if message_callback is None:
324
247
            if message is not None:
325
 
                if isinstance(message, bytes):
326
 
                    message = message.decode(get_user_encoding())
 
248
                if isinstance(message, str):
 
249
                    message = message.decode(bzrlib.user_encoding)
327
250
                message_callback = lambda x: message
328
251
            else:
329
252
                raise BzrError("The message or message_callback keyword"
330
253
                               " parameter is required for commit().")
331
254
 
332
255
        self.bound_branch = None
 
256
        self.any_entries_changed = False
333
257
        self.any_entries_deleted = False
334
 
        if exclude is not None:
335
 
            self.exclude = sorted(
336
 
                minimum_path_selection(exclude))
337
 
        else:
338
 
            self.exclude = []
339
258
        self.local = local
340
259
        self.master_branch = None
 
260
        self.master_locked = False
341
261
        self.recursive = recursive
342
262
        self.rev_id = None
343
 
        # self.specific_files is None to indicate no filter, or any iterable to
344
 
        # indicate a filter - [] means no files at all, as per iter_changes.
345
263
        if specific_files is not None:
346
264
            self.specific_files = sorted(
347
265
                minimum_path_selection(specific_files))
348
266
        else:
349
267
            self.specific_files = None
350
 
 
 
268
        self.specific_file_ids = None
351
269
        self.allow_pointless = allow_pointless
 
270
        self.revprops = revprops
352
271
        self.message_callback = message_callback
353
272
        self.timestamp = timestamp
354
273
        self.timezone = timezone
355
274
        self.committer = committer
356
275
        self.strict = strict
357
276
        self.verbose = verbose
 
277
        # accumulates an inventory delta to the basis entry, so we can make
 
278
        # just the necessary updates to the workingtree's cached basis.
 
279
        self._basis_delta = []
358
280
 
359
281
        self.work_tree.lock_write()
360
 
        operation.add_cleanup(self.work_tree.unlock)
361
 
        self.parents = self.work_tree.get_parent_ids()
362
 
        self.pb = ui.ui_factory.nested_progress_bar()
363
 
        operation.add_cleanup(self.pb.finished)
 
282
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
364
283
        self.basis_revid = self.work_tree.last_revision()
365
284
        self.basis_tree = self.work_tree.basis_tree()
366
285
        self.basis_tree.lock_read()
367
 
        operation.add_cleanup(self.basis_tree.unlock)
368
 
        # Cannot commit with conflicts present.
369
 
        if len(self.work_tree.conflicts()) > 0:
370
 
            raise ConflictsInTree
371
 
 
372
 
        # Setup the bound branch variables as needed.
373
 
        self._check_bound_branch(operation, possible_master_transports)
374
 
 
375
 
        # Check that the working tree is up to date
376
 
        old_revno, old_revid, new_revno = self._check_out_of_date_tree()
377
 
 
378
 
        # Complete configuration setup
379
 
        if reporter is not None:
380
 
            self.reporter = reporter
381
 
        elif self.reporter is None:
382
 
            self.reporter = self._select_reporter()
383
 
        if self.config_stack is None:
384
 
            self.config_stack = self.work_tree.get_config_stack()
385
 
 
386
 
        # Setup the progress bar. As the number of files that need to be
387
 
        # committed in unknown, progress is reported as stages.
388
 
        # We keep track of entries separately though and include that
389
 
        # information in the progress bar during the relevant stages.
390
 
        self.pb_stage_name = ""
391
 
        self.pb_stage_count = 0
392
 
        self.pb_stage_total = 5
393
 
        if self.bound_branch:
394
 
            # 2 extra stages: "Uploading data to master branch" and "Merging
395
 
            # tags to master branch"
396
 
            self.pb_stage_total += 2
397
 
        self.pb.show_pct = False
398
 
        self.pb.show_spinner = False
399
 
        self.pb.show_eta = False
400
 
        self.pb.show_count = True
401
 
        self.pb.show_bar = True
402
 
 
403
 
        # After a merge, a selected file commit is not supported.
404
 
        # See 'bzr help merge' for an explanation as to why.
405
 
        if len(self.parents) > 1 and self.specific_files is not None:
406
 
            raise CannotCommitSelectedFileMerge(self.specific_files)
407
 
        # Excludes are a form of selected file commit.
408
 
        if len(self.parents) > 1 and self.exclude:
409
 
            raise CannotCommitSelectedFileMerge(self.exclude)
410
 
 
411
 
        # Collect the changes
412
 
        self._set_progress_stage("Collecting changes", counter=True)
413
 
        self._lossy = lossy
414
 
        self.builder = self.branch.get_commit_builder(self.parents,
415
 
            self.config_stack, timestamp, timezone, committer, self.revprops,
416
 
            rev_id, lossy=lossy)
417
 
 
418
 
        if self.builder.updates_branch and self.bound_branch:
419
 
            self.builder.abort()
420
 
            raise AssertionError(
421
 
                "bound branches not supported for commit builders "
422
 
                "that update the branch")
423
 
 
424
286
        try:
425
 
            # find the location being committed to
 
287
            # Cannot commit with conflicts present.
 
288
            if len(self.work_tree.conflicts()) > 0:
 
289
                raise ConflictsInTree
 
290
 
 
291
            # Setup the bound branch variables as needed.
 
292
            self._check_bound_branch()
 
293
 
 
294
            # Check that the working tree is up to date
 
295
            old_revno, new_revno = self._check_out_of_date_tree()
 
296
 
 
297
            # Complete configuration setup
 
298
            if reporter is not None:
 
299
                self.reporter = reporter
 
300
            elif self.reporter is None:
 
301
                self.reporter = self._select_reporter()
 
302
            if self.config is None:
 
303
                self.config = self.branch.get_config()
 
304
 
 
305
            # If provided, ensure the specified files are versioned
 
306
            if self.specific_files is not None:
 
307
                # Note: This routine is being called because it raises
 
308
                # PathNotVersionedError as a side effect of finding the IDs. We
 
309
                # later use the ids we found as input to the working tree
 
310
                # inventory iterator, so we only consider those ids rather than
 
311
                # examining the whole tree again.
 
312
                # XXX: Dont we have filter_unversioned to do this more
 
313
                # cheaply?
 
314
                self.specific_file_ids = tree.find_ids_across_trees(
 
315
                    specific_files, [self.basis_tree, self.work_tree])
 
316
 
 
317
            # Setup the progress bar. As the number of files that need to be
 
318
            # committed in unknown, progress is reported as stages.
 
319
            # We keep track of entries separately though and include that
 
320
            # information in the progress bar during the relevant stages.
 
321
            self.pb_stage_name = ""
 
322
            self.pb_stage_count = 0
 
323
            self.pb_stage_total = 5
426
324
            if self.bound_branch:
427
 
                master_location = self.master_branch.base
428
 
            else:
429
 
                master_location = self.branch.base
430
 
 
431
 
            # report the start of the commit
432
 
            self.reporter.started(new_revno, self.rev_id, master_location)
433
 
 
434
 
            self._update_builder_with_changes()
435
 
            self._check_pointless()
436
 
 
437
 
            # TODO: Now the new inventory is known, check for conflicts.
438
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
439
 
            # weave lines, because nothing should be recorded until it is known
440
 
            # that commit will succeed.
441
 
            self._set_progress_stage("Saving data locally")
442
 
            self.builder.finish_inventory()
443
 
 
444
 
            # Prompt the user for a commit message if none provided
445
 
            message = message_callback(self)
446
 
            self.message = message
447
 
 
448
 
            # Add revision data to the local branch
449
 
            self.rev_id = self.builder.commit(self.message)
450
 
 
451
 
        except Exception as e:
452
 
            mutter("aborting commit write group because of exception:")
453
 
            trace.log_exception_quietly()
454
 
            self.builder.abort()
455
 
            raise
456
 
 
457
 
        self._update_branches(old_revno, old_revid, new_revno)
458
 
 
459
 
        # Make the working tree be up to date with the branch. This
460
 
        # includes automatic changes scheduled to be made to the tree, such
461
 
        # as updating its basis and unversioning paths that were missing.
462
 
        self.work_tree.unversion(self.deleted_paths)
463
 
        self._set_progress_stage("Updating the working tree")
464
 
        self.work_tree.update_basis_by_delta(self.rev_id,
465
 
             self.builder.get_basis_delta())
466
 
        self.reporter.completed(new_revno, self.rev_id)
467
 
        self._process_post_hooks(old_revno, new_revno)
468
 
        return self.rev_id
469
 
 
470
 
    def _update_branches(self, old_revno, old_revid, new_revno):
471
 
        """Update the master and local branch to the new revision.
472
 
 
473
 
        This will try to make sure that the master branch is updated
474
 
        before the local branch.
475
 
 
476
 
        :param old_revno: Revision number of master branch before the
477
 
            commit
478
 
        :param old_revid: Tip of master branch before the commit
479
 
        :param new_revno: Revision number of the new commit
480
 
        """
481
 
        if not self.builder.updates_branch:
 
325
                self.pb_stage_total += 1
 
326
            self.pb.show_pct = False
 
327
            self.pb.show_spinner = False
 
328
            self.pb.show_eta = False
 
329
            self.pb.show_count = True
 
330
            self.pb.show_bar = True
 
331
 
 
332
            # After a merge, a selected file commit is not supported.
 
333
            # See 'bzr help merge' for an explanation as to why.
 
334
            self.basis_inv = self.basis_tree.inventory
 
335
            self._gather_parents()
 
336
            if len(self.parents) > 1 and self.specific_files:
 
337
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
338
 
 
339
            # Collect the changes
 
340
            self._set_progress_stage("Collecting changes",
 
341
                    entries_title="Directory")
 
342
            self.builder = self.branch.get_commit_builder(self.parents,
 
343
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
344
            
 
345
            try:
 
346
                # find the location being committed to
 
347
                if self.bound_branch:
 
348
                    master_location = self.master_branch.base
 
349
                else:
 
350
                    master_location = self.branch.base
 
351
 
 
352
                # report the start of the commit
 
353
                self.reporter.started(new_revno, self.rev_id, master_location)
 
354
 
 
355
                self._update_builder_with_changes()
 
356
                self._report_and_accumulate_deletes()
 
357
                self._check_pointless()
 
358
 
 
359
                # TODO: Now the new inventory is known, check for conflicts.
 
360
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
361
                # weave lines, because nothing should be recorded until it is known
 
362
                # that commit will succeed.
 
363
                self._set_progress_stage("Saving data locally")
 
364
                self.builder.finish_inventory()
 
365
 
 
366
                # Prompt the user for a commit message if none provided
 
367
                message = message_callback(self)
 
368
                self.message = message
 
369
                self._escape_commit_message()
 
370
 
 
371
                # Add revision data to the local branch
 
372
                self.rev_id = self.builder.commit(self.message)
 
373
 
 
374
            except:
 
375
                self.builder.abort()
 
376
                raise
 
377
 
482
378
            self._process_pre_hooks(old_revno, new_revno)
483
379
 
484
380
            # Upload revision data to the master.
485
381
            # this will propagate merged revisions too if needed.
486
382
            if self.bound_branch:
487
 
                self._set_progress_stage("Uploading data to master branch")
 
383
                if not self.master_branch.repository.has_same_location(
 
384
                        self.branch.repository):
 
385
                    self._set_progress_stage("Uploading data to master branch")
 
386
                    self.master_branch.repository.fetch(self.branch.repository,
 
387
                        revision_id=self.rev_id)
 
388
                # now the master has the revision data
488
389
                # 'commit' to the master first so a timeout here causes the
489
390
                # local branch to be out of date
490
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
491
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
492
 
                if self._lossy:
493
 
                    self.branch.fetch(self.master_branch, self.rev_id)
 
391
                self.master_branch.set_last_revision_info(new_revno,
 
392
                                                          self.rev_id)
494
393
 
495
394
            # and now do the commit locally.
496
395
            self.branch.set_last_revision_info(new_revno, self.rev_id)
497
 
        else:
498
 
            try:
499
 
                self._process_pre_hooks(old_revno, new_revno)
500
 
            except:
501
 
                # The commit builder will already have updated the branch,
502
 
                # revert it.
503
 
                self.branch.set_last_revision_info(old_revno, old_revid)
504
 
                raise
505
396
 
506
 
        # Merge local tags to remote
507
 
        if self.bound_branch:
508
 
            self._set_progress_stage("Merging tags to master branch")
509
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
510
 
                self.master_branch.tags)
511
 
            if tag_conflicts:
512
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
513
 
                note( gettext("Conflicting tags in bound branch:\n{0}".format(
514
 
                    "\n".join(warning_lines))) )
 
397
            # Make the working tree up to date with the branch
 
398
            self._set_progress_stage("Updating the working tree")
 
399
            self.work_tree.update_basis_by_delta(self.rev_id,
 
400
                 self._basis_delta)
 
401
            self.reporter.completed(new_revno, self.rev_id)
 
402
            self._process_post_hooks(old_revno, new_revno)
 
403
        finally:
 
404
            self._cleanup()
 
405
        return self.rev_id
515
406
 
516
407
    def _select_reporter(self):
517
408
        """Select the CommitReporter to use."""
525
416
        # A merge with no effect on files
526
417
        if len(self.parents) > 1:
527
418
            return
528
 
        if self.builder.any_changes():
 
419
        # TODO: we could simplify this by using self._basis_delta.
 
420
 
 
421
        # The initial commit adds a root directory, but this in itself is not
 
422
        # a worthwhile commit.
 
423
        if (self.basis_revid == revision.NULL_REVISION and
 
424
            len(self.builder.new_inventory) == 1):
 
425
            raise PointlessCommit()
 
426
        # If length == 1, then we only have the root entry. Which means
 
427
        # that there is no real difference (only the root could be different)
 
428
        # unless deletes occured, in which case the length is irrelevant.
 
429
        if (self.any_entries_deleted or 
 
430
            (len(self.builder.new_inventory) != 1 and
 
431
             self.any_entries_changed)):
529
432
            return
530
433
        raise PointlessCommit()
531
434
 
532
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
435
    def _check_bound_branch(self):
533
436
        """Check to see if the local branch is bound.
534
437
 
535
438
        If it is bound, then most of the commit will actually be
540
443
            raise errors.LocalRequiresBoundBranch()
541
444
 
542
445
        if not self.local:
543
 
            self.master_branch = self.branch.get_master_branch(
544
 
                possible_master_transports)
 
446
            self.master_branch = self.branch.get_master_branch()
545
447
 
546
448
        if not self.master_branch:
547
449
            # make this branch the reference branch for out of date checks.
558
460
        #       commits to the remote branch if they would fit.
559
461
        #       But for now, just require remote to be identical
560
462
        #       to local.
561
 
 
 
463
        
562
464
        # Make sure the local branch is identical to the master
563
465
        master_info = self.master_branch.last_revision_info()
564
466
        local_info = self.branch.last_revision_info()
570
472
        # so grab the lock
571
473
        self.bound_branch = self.branch
572
474
        self.master_branch.lock_write()
573
 
        operation.add_cleanup(self.master_branch.unlock)
 
475
        self.master_locked = True
574
476
 
575
477
    def _check_out_of_date_tree(self):
576
478
        """Check that the working tree is up to date.
577
479
 
578
 
        :return: old_revision_number, old_revision_id, new_revision_number
579
 
            tuple
 
480
        :return: old_revision_number,new_revision_number tuple
580
481
        """
581
482
        try:
582
483
            first_tree_parent = self.work_tree.get_parent_ids()[0]
585
486
            # this is so that we still consider the master branch
586
487
            # - in a checkout scenario the tree may have no
587
488
            # parents but the branch may do.
588
 
            first_tree_parent = breezy.revision.NULL_REVISION
 
489
            first_tree_parent = bzrlib.revision.NULL_REVISION
589
490
        old_revno, master_last = self.master_branch.last_revision_info()
590
491
        if master_last != first_tree_parent:
591
 
            if master_last != breezy.revision.NULL_REVISION:
 
492
            if master_last != bzrlib.revision.NULL_REVISION:
592
493
                raise errors.OutOfDateTree(self.work_tree)
593
494
        if self.branch.repository.has_revision(first_tree_parent):
594
495
            new_revno = old_revno + 1
595
496
        else:
596
497
            # ghost parents never appear in revision history.
597
498
            new_revno = 1
598
 
        return old_revno, master_last, new_revno
 
499
        return old_revno,new_revno
599
500
 
600
501
    def _process_pre_hooks(self, old_revno, new_revno):
601
502
        """Process any registered pre commit hooks."""
607
508
        # Process the post commit hooks, if any
608
509
        self._set_progress_stage("Running post_commit hooks")
609
510
        # old style commit hooks - should be deprecated ? (obsoleted in
610
 
        # 0.15^H^H^H^H 2.5.0)
611
 
        post_commit = self.config_stack.get('post_commit')
612
 
        if post_commit is not None:
613
 
            hooks = post_commit.split(' ')
 
511
        # 0.15)
 
512
        if self.config.post_commit() is not None:
 
513
            hooks = self.config.post_commit().split(' ')
614
514
            # this would be nicer with twisted.python.reflect.namedAny
615
515
            for hook in hooks:
616
516
                result = eval(hook + '(branch, rev_id)',
617
517
                              {'branch':self.branch,
618
 
                               'breezy':breezy,
 
518
                               'bzrlib':bzrlib,
619
519
                               'rev_id':self.rev_id})
620
520
        # process new style post commit hooks
621
521
        self._process_hooks("post_commit", old_revno, new_revno)
623
523
    def _process_hooks(self, hook_name, old_revno, new_revno):
624
524
        if not Branch.hooks[hook_name]:
625
525
            return
626
 
 
 
526
        
627
527
        # new style commit hooks:
628
528
        if not self.bound_branch:
629
529
            hook_master = self.branch
637
537
        if self.parents:
638
538
            old_revid = self.parents[0]
639
539
        else:
640
 
            old_revid = breezy.revision.NULL_REVISION
641
 
 
 
540
            old_revid = bzrlib.revision.NULL_REVISION
 
541
        
642
542
        if hook_name == "pre_commit":
643
543
            future_tree = self.builder.revision_tree()
644
544
            tree_delta = future_tree.changes_from(self.basis_tree,
645
545
                                             include_root=True)
646
 
 
 
546
        
647
547
        for hook in Branch.hooks[hook_name]:
648
548
            # show the running hook in the progress bar. As hooks may
649
549
            # end up doing nothing (e.g. because they are not configured by
663
563
                     old_revno, old_revid, new_revno, self.rev_id,
664
564
                     tree_delta, future_tree)
665
565
 
 
566
    def _cleanup(self):
 
567
        """Cleanup any open locks, progress bars etc."""
 
568
        cleanups = [self._cleanup_bound_branch,
 
569
                    self.basis_tree.unlock,
 
570
                    self.work_tree.unlock,
 
571
                    self.pb.finished]
 
572
        found_exception = None
 
573
        for cleanup in cleanups:
 
574
            try:
 
575
                cleanup()
 
576
            # we want every cleanup to run no matter what.
 
577
            # so we have a catchall here, but we will raise the
 
578
            # last encountered exception up the stack: and
 
579
            # typically this will be useful enough.
 
580
            except Exception, e:
 
581
                found_exception = e
 
582
        if found_exception is not None: 
 
583
            # don't do a plan raise, because the last exception may have been
 
584
            # trashed, e is our sure-to-work exception even though it loses the
 
585
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
586
            # exc_info and if its the same one do a plain raise otherwise 
 
587
            # 'raise e' as we do now.
 
588
            raise e
 
589
 
 
590
    def _cleanup_bound_branch(self):
 
591
        """Executed at the end of a try/finally to cleanup a bound branch.
 
592
 
 
593
        If the branch wasn't bound, this is a no-op.
 
594
        If it was, it resents self.branch to the local branch, instead
 
595
        of being the master.
 
596
        """
 
597
        if not self.bound_branch:
 
598
            return
 
599
        if self.master_locked:
 
600
            self.master_branch.unlock()
 
601
 
 
602
    def _escape_commit_message(self):
 
603
        """Replace xml-incompatible control characters."""
 
604
        # FIXME: RBC 20060419 this should be done by the revision
 
605
        # serialiser not by commit. Then we can also add an unescaper
 
606
        # in the deserializer and start roundtripping revision messages
 
607
        # precisely. See repository_implementations/test_repository.py
 
608
        
 
609
        # Python strings can include characters that can't be
 
610
        # represented in well-formed XML; escape characters that
 
611
        # aren't listed in the XML specification
 
612
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
613
        self.message, escape_count = re.subn(
 
614
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
615
            lambda match: match.group(0).encode('unicode_escape'),
 
616
            self.message)
 
617
        if escape_count:
 
618
            self.reporter.escaped(escape_count, self.message)
 
619
 
 
620
    def _gather_parents(self):
 
621
        """Record the parents of a merge for merge detection."""
 
622
        # TODO: Make sure that this list doesn't contain duplicate 
 
623
        # entries and the order is preserved when doing this.
 
624
        self.parents = self.work_tree.get_parent_ids()
 
625
        self.parent_invs = [self.basis_inv]
 
626
        for revision in self.parents[1:]:
 
627
            if self.branch.repository.has_revision(revision):
 
628
                mutter('commit parent revision {%s}', revision)
 
629
                inventory = self.branch.repository.get_inventory(revision)
 
630
                self.parent_invs.append(inventory)
 
631
            else:
 
632
                mutter('commit parent ghost revision {%s}', revision)
 
633
 
666
634
    def _update_builder_with_changes(self):
667
635
        """Update the commit builder with the data about what has changed.
668
636
        """
 
637
        # Build the revision inventory.
 
638
        #
 
639
        # This starts by creating a new empty inventory. Depending on
 
640
        # which files are selected for commit, and what is present in the
 
641
        # current tree, the new inventory is populated. inventory entries 
 
642
        # which are candidates for modification have their revision set to
 
643
        # None; inventory entries that are carried over untouched have their
 
644
        # revision set to their prior value.
 
645
        #
 
646
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
647
        # results to create a new inventory at the same time, which results
 
648
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
649
        # ADHB 11-07-2006
 
650
 
669
651
        specific_files = self.specific_files
670
 
        mutter("Selecting files for commit with filter %r", specific_files)
671
 
 
672
 
        self._check_strict()
673
 
        iter_changes = self.work_tree.iter_changes(self.basis_tree,
674
 
            specific_files=specific_files)
675
 
        if self.exclude:
676
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
677
 
        iter_changes = self._filter_iter_changes(iter_changes)
678
 
        for file_id, path, fs_hash in self.builder.record_iter_changes(
679
 
            self.work_tree, self.basis_revid, iter_changes):
680
 
            self.work_tree._observed_sha1(file_id, path, fs_hash)
681
 
 
682
 
    def _filter_iter_changes(self, iter_changes):
683
 
        """Process iter_changes.
684
 
 
685
 
        This method reports on the changes in iter_changes to the user, and 
686
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
687
 
        entries. 'missing' entries have their
688
 
 
689
 
        :param iter_changes: An iter_changes to process.
690
 
        :return: A generator of changes.
691
 
        """
692
 
        reporter = self.reporter
693
 
        report_changes = reporter.is_verbose()
694
 
        deleted_paths = []
695
 
        for change in iter_changes:
696
 
            if report_changes:
697
 
                old_path = change[1][0]
698
 
                new_path = change[1][1]
699
 
                versioned = change[3][1]
700
 
            kind = change[6][1]
701
 
            versioned = change[3][1]
702
 
            if kind is None and versioned:
703
 
                # 'missing' path
704
 
                if report_changes:
705
 
                    reporter.missing(new_path)
706
 
                deleted_paths.append(change[1][1])
707
 
                # Reset the new path (None) and new versioned flag (False)
708
 
                change = (change[0], (change[1][0], None), change[2],
709
 
                    (change[3][0], False)) + change[4:]
710
 
                new_path = change[1][1]
711
 
                versioned = False
712
 
            elif kind == 'tree-reference':
713
 
                if self.recursive == 'down':
714
 
                    self._commit_nested_tree(change[0], change[1][1])
715
 
            if change[3][0] or change[3][1]:
716
 
                yield change
717
 
                if report_changes:
718
 
                    if new_path is None:
719
 
                        reporter.deleted(old_path)
720
 
                    elif old_path is None:
721
 
                        reporter.snapshot_change(gettext('added'), new_path)
722
 
                    elif old_path != new_path:
723
 
                        reporter.renamed(gettext('renamed'), old_path, new_path)
724
 
                    else:
725
 
                        if (new_path or 
726
 
                            self.work_tree.branch.repository._format.rich_root_data):
727
 
                            # Don't report on changes to '' in non rich root
728
 
                            # repositories.
729
 
                            reporter.snapshot_change(gettext('modified'), new_path)
730
 
            self._next_progress_entry()
731
 
        # Unversion files that were found to be deleted
732
 
        self.deleted_paths = deleted_paths
733
 
 
734
 
    def _check_strict(self):
735
 
        # XXX: when we use iter_changes this would likely be faster if
736
 
        # iter_changes would check for us (even in the presence of
737
 
        # selected_files).
 
652
        mutter("Selecting files for commit with filter %s", specific_files)
 
653
 
 
654
        # Build the new inventory
 
655
        self._populate_from_inventory(specific_files)
 
656
 
 
657
        # If specific files are selected, then all un-selected files must be
 
658
        # recorded in their previous state. For more details, see
 
659
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
660
        if specific_files:
 
661
            for path, old_ie in self.basis_inv.iter_entries():
 
662
                if old_ie.file_id in self.builder.new_inventory:
 
663
                    # already added - skip.
 
664
                    continue
 
665
                if is_inside_any(specific_files, path):
 
666
                    # was inside the selected path, if not present it has been
 
667
                    # deleted so skip.
 
668
                    continue
 
669
                if old_ie.kind == 'directory':
 
670
                    self._next_progress_entry()
 
671
                # not in final inv yet, was not in the selected files, so is an
 
672
                # entry to be preserved unaltered.
 
673
                ie = old_ie.copy()
 
674
                # Note: specific file commits after a merge are currently
 
675
                # prohibited. This test is for sanity/safety in case it's
 
676
                # required after that changes.
 
677
                if len(self.parents) > 1:
 
678
                    ie.revision = None
 
679
                delta, version_recorded = self.builder.record_entry_contents(
 
680
                    ie, self.parent_invs, path, self.basis_tree, None)
 
681
                if version_recorded:
 
682
                    self.any_entries_changed = True
 
683
                if delta: self._basis_delta.append(delta)
 
684
 
 
685
    def _report_and_accumulate_deletes(self):
 
686
        # XXX: Could the list of deleted paths and ids be instead taken from
 
687
        # _populate_from_inventory?
 
688
        deleted_ids = set(self.basis_inv._byid.keys()) - \
 
689
            set(self.builder.new_inventory._byid.keys())
 
690
        if deleted_ids:
 
691
            self.any_entries_deleted = True
 
692
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
693
                for file_id in deleted_ids]
 
694
            deleted.sort()
 
695
            # XXX: this is not quite directory-order sorting
 
696
            for path, file_id in deleted:
 
697
                self._basis_delta.append((path, None, file_id, None))
 
698
                self.reporter.deleted(path)
 
699
 
 
700
    def _populate_from_inventory(self, specific_files):
 
701
        """Populate the CommitBuilder by walking the working tree inventory."""
738
702
        if self.strict:
739
703
            # raise an exception as soon as we find a single unknown.
740
704
            for unknown in self.work_tree.unknowns():
741
705
                raise StrictCommitFailed()
 
706
               
 
707
        report_changes = self.reporter.is_verbose()
 
708
        deleted_ids = []
 
709
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
710
        # deleted, then we have {'foo':{'bar':{}}}
 
711
        deleted_paths = {}
 
712
        # XXX: Note that entries may have the wrong kind because the entry does
 
713
        # not reflect the status on disk.
 
714
        work_inv = self.work_tree.inventory
 
715
        entries = work_inv.iter_entries_by_dir(
 
716
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
717
        for path, existing_ie in entries:
 
718
            file_id = existing_ie.file_id
 
719
            name = existing_ie.name
 
720
            parent_id = existing_ie.parent_id
 
721
            kind = existing_ie.kind
 
722
            if kind == 'directory':
 
723
                self._next_progress_entry()
 
724
            # Skip files that have been deleted from the working tree.
 
725
            # The deleted path ids are also recorded so they can be explicitly
 
726
            # unversioned later.
 
727
            if deleted_paths:
 
728
                path_segments = splitpath(path)
 
729
                deleted_dict = deleted_paths
 
730
                for segment in path_segments:
 
731
                    deleted_dict = deleted_dict.get(segment, None)
 
732
                    if not deleted_dict:
 
733
                        # We either took a path not present in the dict
 
734
                        # (deleted_dict was None), or we've reached an empty
 
735
                        # child dir in the dict, so are now a sub-path.
 
736
                        break
 
737
                else:
 
738
                    deleted_dict = None
 
739
                if deleted_dict is not None:
 
740
                    # the path has a deleted parent, do not add it.
 
741
                    continue
 
742
            content_summary = self.work_tree.path_content_summary(path)
 
743
            # Note that when a filter of specific files is given, we must only
 
744
            # skip/record deleted files matching that filter.
 
745
            if not specific_files or is_inside_any(specific_files, path):
 
746
                if content_summary[0] == 'missing':
 
747
                    if not deleted_paths:
 
748
                        # path won't have been split yet.
 
749
                        path_segments = splitpath(path)
 
750
                    deleted_dict = deleted_paths
 
751
                    for segment in path_segments:
 
752
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
753
                    self.reporter.missing(path)
 
754
                    deleted_ids.append(file_id)
 
755
                    continue
 
756
            # TODO: have the builder do the nested commit just-in-time IF and
 
757
            # only if needed.
 
758
            if content_summary[0] == 'tree-reference':
 
759
                # enforce repository nested tree policy.
 
760
                if (not self.work_tree.supports_tree_reference() or
 
761
                    # repository does not support it either.
 
762
                    not self.branch.repository._format.supports_tree_reference):
 
763
                    content_summary = ('directory',) + content_summary[1:]
 
764
            kind = content_summary[0]
 
765
            # TODO: specific_files filtering before nested tree processing
 
766
            if kind == 'tree-reference':
 
767
                if self.recursive == 'down':
 
768
                    nested_revision_id = self._commit_nested_tree(
 
769
                        file_id, path)
 
770
                    content_summary = content_summary[:3] + (
 
771
                        nested_revision_id,)
 
772
                else:
 
773
                    content_summary = content_summary[:3] + (
 
774
                        self.work_tree.get_reference_revision(file_id),)
 
775
 
 
776
            # Record an entry for this item
 
777
            # Note: I don't particularly want to have the existing_ie
 
778
            # parameter but the test suite currently (28-Jun-07) breaks
 
779
            # without it thanks to a unicode normalisation issue. :-(
 
780
            definitely_changed = kind != existing_ie.kind
 
781
            self._record_entry(path, file_id, specific_files, kind, name,
 
782
                parent_id, definitely_changed, existing_ie, report_changes,
 
783
                content_summary)
 
784
 
 
785
        # Unversion IDs that were found to be deleted
 
786
        self.work_tree.unversion(deleted_ids)
742
787
 
743
788
    def _commit_nested_tree(self, file_id, path):
744
789
        "Commit a nested tree."
745
 
        sub_tree = self.work_tree.get_nested_tree(path, file_id)
 
790
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
746
791
        # FIXME: be more comprehensive here:
747
792
        # this works when both trees are in --trees repository,
748
793
        # but when both are bound to a different repository,
749
 
        # it fails; a better way of approaching this is to
 
794
        # it fails; a better way of approaching this is to 
750
795
        # finally implement the explicit-caches approach design
751
796
        # a while back - RBC 20070306.
752
797
        if sub_tree.branch.repository.has_same_location(
762
807
                allow_pointless=self.allow_pointless,
763
808
                strict=self.strict, verbose=self.verbose,
764
809
                local=self.local, reporter=self.reporter)
765
 
        except PointlessCommit:
766
 
            return self.work_tree.get_reference_revision(path, file_id)
767
 
 
768
 
    def _set_progress_stage(self, name, counter=False):
 
810
        except errors.PointlessCommit:
 
811
            return self.work_tree.get_reference_revision(file_id)
 
812
 
 
813
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
814
        parent_id, definitely_changed, existing_ie, report_changes,
 
815
        content_summary):
 
816
        "Record the new inventory entry for a path if any."
 
817
        # mutter('check %s {%s}', path, file_id)
 
818
        # mutter('%s selected for commit', path)
 
819
        if definitely_changed or existing_ie is None:
 
820
            ie = make_entry(kind, name, parent_id, file_id)
 
821
        else:
 
822
            ie = existing_ie.copy()
 
823
            ie.revision = None
 
824
        delta, version_recorded = self.builder.record_entry_contents(ie,
 
825
            self.parent_invs, path, self.work_tree, content_summary)
 
826
        if delta:
 
827
            self._basis_delta.append(delta)
 
828
        if version_recorded:
 
829
            self.any_entries_changed = True
 
830
        if report_changes:
 
831
            self._report_change(ie, path)
 
832
        return ie
 
833
 
 
834
    def _report_change(self, ie, path):
 
835
        """Report a change to the user.
 
836
 
 
837
        The change that has occurred is described relative to the basis
 
838
        inventory.
 
839
        """
 
840
        if (self.basis_inv.has_id(ie.file_id)):
 
841
            basis_ie = self.basis_inv[ie.file_id]
 
842
        else:
 
843
            basis_ie = None
 
844
        change = ie.describe_change(basis_ie, ie)
 
845
        if change in (InventoryEntry.RENAMED, 
 
846
            InventoryEntry.MODIFIED_AND_RENAMED):
 
847
            old_path = self.basis_inv.id2path(ie.file_id)
 
848
            self.reporter.renamed(change, old_path, path)
 
849
        else:
 
850
            self.reporter.snapshot_change(change, path)
 
851
 
 
852
    def _set_progress_stage(self, name, entries_title=None):
769
853
        """Set the progress stage and emit an update to the progress bar."""
770
854
        self.pb_stage_name = name
771
855
        self.pb_stage_count += 1
772
 
        if counter:
 
856
        self.pb_entries_title = entries_title
 
857
        if entries_title is not None:
773
858
            self.pb_entries_count = 0
774
 
        else:
775
 
            self.pb_entries_count = None
 
859
            self.pb_entries_total = '?'
776
860
        self._emit_progress()
777
861
 
778
862
    def _next_progress_entry(self):
781
865
        self._emit_progress()
782
866
 
783
867
    def _emit_progress(self):
784
 
        if self.pb_entries_count is not None:
785
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
786
 
                self.pb_entries_count)
 
868
        if self.pb_entries_title:
 
869
            if self.pb_entries_total == '?':
 
870
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
871
                    self.pb_entries_title, self.pb_entries_count)
 
872
            else:
 
873
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
874
                    self.pb_entries_title, self.pb_entries_count,
 
875
                    str(self.pb_entries_total))
787
876
        else:
788
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
877
            text = "%s - Stage" % (self.pb_stage_name)
789
878
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
879