← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
# XXX: Can we do any better about making interrupted commits change
19
 
# nothing?  Perhaps the best approach is to integrate commit of
20
 
# AtomicFiles with releasing the lock on the Branch.
21
 
 
22
 
# TODO: Separate 'prepare' phase where we find a list of potentially
23
 
# committed files.  We then can then pause the commit to prompt for a
24
 
# commit message, knowing the summary will be the same as what's
25
 
# actually used for the commit.  (But perhaps simpler to simply get
26
 
# the tree status, then use that for a selective commit?)
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
27
18
 
28
19
# The newly committed revision is going to have a shape corresponding
29
 
# to that of the working inventory.  Files that are not in the
 
20
# to that of the working tree.  Files that are not in the
30
21
# working tree and that were in the predecessor are reported as
31
22
# removed --- this can include files that were either removed from the
32
23
# inventory or deleted in the working tree.  If they were only
35
26
# We then consider the remaining entries, which will be in the new
36
27
# version.  Directory entries are simply copied across.  File entries
37
28
# must be checked to see if a new version of the file should be
38
 
# recorded.  For each parent revision inventory, we check to see what
 
29
# recorded.  For each parent revision tree, we check to see what
39
30
# version of the file was present.  If the file was present in at
40
31
# least one tree, and if it was the same version in all the trees,
41
32
# then we can just refer to that version.  Otherwise, a new version
44
35
# TODO: Update hashcache before and after - or does the WorkingTree
45
36
# look after that?
46
37
 
47
 
# This code requires all merge parents to be present in the branch.
48
 
# We could relax this but for the sake of simplicity the constraint is
49
 
# here for now.  It's not totally clear to me how we'd know which file
50
 
# need new text versions if some parents are absent.  -- mbp 20050915
51
 
 
52
38
# TODO: Rather than mashing together the ancestry and storing it back,
53
39
# perhaps the weave should have single method which does it all in one
54
40
# go, avoiding a lot of redundant work.
61
47
# merges from, then it should still be reported as newly added
62
48
# relative to the basis revision.
63
49
 
64
 
 
65
 
import os
66
 
import re
67
 
import sys
68
 
import time
69
 
import pdb
70
 
 
71
 
from binascii import hexlify
72
 
from cStringIO import StringIO
73
 
 
74
 
from bzrlib.osutils import (local_time_offset, username,
75
 
                            rand_bytes, compact_date, user_email,
76
 
                            kind_marker, is_inside_any, quotefn,
77
 
                            sha_string, sha_strings, sha_file, isdir, isfile,
78
 
                            split_lines)
79
 
from bzrlib.branch import gen_file_id
 
50
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
 
51
# the rest of the code; add a deprecation of the old name.
 
52
 
 
53
from bzrlib import (
 
54
    debug,
 
55
    errors,
 
56
    trace,
 
57
    tree,
 
58
    ui,
 
59
    )
 
60
from bzrlib.branch import Branch
 
61
from bzrlib.cleanup import OperationWithCleanups
 
62
import bzrlib.config
80
63
from bzrlib.errors import (BzrError, PointlessCommit,
81
 
                           HistoryMissing,
 
64
                           ConflictsInTree,
 
65
                           StrictCommitFailed
82
66
                           )
83
 
from bzrlib.revision import Revision
84
 
from bzrlib.trace import mutter, note, warning
85
 
from bzrlib.xml5 import serializer_v5
86
 
from bzrlib.inventory import Inventory
87
 
from bzrlib.weave import Weave
88
 
from bzrlib.weavefile import read_weave, write_weave_v5
89
 
from bzrlib.atomicfile import AtomicFile
90
 
 
91
 
 
92
 
def commit(*args, **kwargs):
93
 
    """Commit a new revision to a branch.
94
 
 
95
 
    Function-style interface for convenience of old callers.
96
 
 
97
 
    New code should use the Commit class instead.
98
 
    """
99
 
    ## XXX: Remove this in favor of Branch.commit?
100
 
    Commit().commit(*args, **kwargs)
101
 
 
 
67
from bzrlib.osutils import (get_user_encoding,
 
68
                            is_inside_any,
 
69
                            minimum_path_selection,
 
70
                            splitpath,
 
71
                            )
 
72
from bzrlib.trace import mutter, note, is_quiet
 
73
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
74
from bzrlib import symbol_versioning
 
75
from bzrlib.urlutils import unescape_for_display
 
76
from bzrlib.i18n import gettext
102
77
 
103
78
class NullCommitReporter(object):
104
79
    """I report on progress of a commit."""
105
 
    def added(self, path):
106
 
        pass
107
 
 
108
 
    def removed(self, path):
109
 
        pass
110
 
 
111
 
    def renamed(self, old_path, new_path):
112
 
        pass
 
80
 
 
81
    def started(self, revno, revid, location=None):
 
82
        if location is None:
 
83
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
84
                                   "to started.", DeprecationWarning,
 
85
                                   stacklevel=2)
 
86
        pass
 
87
 
 
88
    def snapshot_change(self, change, path):
 
89
        pass
 
90
 
 
91
    def completed(self, revno, rev_id):
 
92
        pass
 
93
 
 
94
    def deleted(self, path):
 
95
        pass
 
96
 
 
97
    def missing(self, path):
 
98
        pass
 
99
 
 
100
    def renamed(self, change, old_path, new_path):
 
101
        pass
 
102
 
 
103
    def is_verbose(self):
 
104
        return False
113
105
 
114
106
 
115
107
class ReportCommitToLog(NullCommitReporter):
116
 
    def added(self, path):
117
 
        note('added %s', path)
118
 
 
119
 
    def removed(self, path):
120
 
        note('removed %s', path)
121
 
 
122
 
    def renamed(self, old_path, new_path):
123
 
        note('renamed %s => %s', old_path, new_path)
 
108
 
 
109
    def _note(self, format, *args):
 
110
        """Output a message.
 
111
 
 
112
        Subclasses may choose to override this method.
 
113
        """
 
114
        note(format, *args)
 
115
 
 
116
    def snapshot_change(self, change, path):
 
117
        if path == '' and change in (gettext('added'), gettext('modified')):
 
118
            return
 
119
        self._note("%s %s", change, path)
 
120
 
 
121
    def started(self, revno, rev_id, location=None):
 
122
        if location is not None:
 
123
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
124
        else:
 
125
            # When started was added, location was only made optional by
 
126
            # accident.  Matt Nordhoff 20071129
 
127
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
128
                                   "to started.", DeprecationWarning,
 
129
                                   stacklevel=2)
 
130
            location = ''
 
131
        self._note(gettext('Committing%s'), location)
 
132
 
 
133
    def completed(self, revno, rev_id):
 
134
        self._note(gettext('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(gettext('deleted %s'), path)
 
144
 
 
145
    def missing(self, path):
 
146
        self._note(gettext('missing %s'), path)
 
147
 
 
148
    def renamed(self, change, old_path, new_path):
 
149
        self._note('%s %s => %s', change, old_path, new_path)
 
150
 
 
151
    def is_verbose(self):
 
152
        return True
124
153
 
125
154
 
126
155
class Commit(object):
136
165
            working inventory.
137
166
    """
138
167
    def __init__(self,
139
 
                 reporter=None):
140
 
        if reporter is not None:
141
 
            self.reporter = reporter
142
 
        else:
143
 
            self.reporter = NullCommitReporter()
144
 
 
145
 
        
 
168
                 reporter=None,
 
169
                 config_stack=None):
 
170
        """Create a Commit object.
 
171
 
 
172
        :param reporter: the default reporter to use or None to decide later
 
173
        """
 
174
        self.reporter = reporter
 
175
        self.config_stack = config_stack
 
176
 
 
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
 
146
214
    def commit(self,
147
 
               branch, message,
 
215
               message=None,
148
216
               timestamp=None,
149
217
               timezone=None,
150
218
               committer=None,
151
219
               specific_files=None,
152
220
               rev_id=None,
153
221
               allow_pointless=True,
154
 
               verbose=False):
 
222
               strict=False,
 
223
               verbose=False,
 
224
               revprops=None,
 
225
               working_tree=None,
 
226
               local=False,
 
227
               reporter=None,
 
228
               config=None,
 
229
               message_callback=None,
 
230
               recursive='down',
 
231
               exclude=None,
 
232
               possible_master_transports=None,
 
233
               lossy=False):
155
234
        """Commit working copy as a new revision.
156
235
 
157
 
        timestamp -- if not None, seconds-since-epoch for a
158
 
             postdated/predated commit.
159
 
 
160
 
        specific_files -- If true, commit only those files.
161
 
 
162
 
        rev_id -- If set, use this as the new revision id.
 
236
        :param message: the commit message (it or message_callback is required)
 
237
        :param message_callback: A callback: message = message_callback(cmt_obj)
 
238
 
 
239
        :param timestamp: if not None, seconds-since-epoch for a
 
240
            postdated/predated commit.
 
241
 
 
242
        :param specific_files: If not None, commit only those files. An empty
 
243
            list means 'commit no files'.
 
244
 
 
245
        :param rev_id: If set, use this as the new revision id.
163
246
            Useful for test or import commands that need to tightly
164
247
            control what revisions are assigned.  If you duplicate
165
248
            a revision id that exists elsewhere it is your own fault.
166
249
            If null (default), a time/random revision id is generated.
167
250
 
168
 
        allow_pointless -- If true (default), commit even if nothing
 
251
        :param allow_pointless: If true (default), commit even if nothing
169
252
            has changed and no merges are recorded.
 
253
 
 
254
        :param strict: If true, don't allow a commit if the working tree
 
255
            contains unknown files.
 
256
 
 
257
        :param revprops: Properties for new revision
 
258
        :param local: Perform a local only commit.
 
259
        :param reporter: the reporter to use or None for the default
 
260
        :param verbose: if True and the reporter is not None, report everything
 
261
        :param recursive: If set to 'down', commit in any subtrees that have
 
262
            pending changes of any sort during this commit.
 
263
        :param exclude: None or a list of relative paths to exclude from the
 
264
            commit. Pending changes to excluded files will be ignored by the
 
265
            commit.
 
266
        :param lossy: When committing to a foreign VCS, ignore any
 
267
            data that can not be natively represented.
170
268
        """
 
269
        operation = OperationWithCleanups(self._commit)
 
270
        self.revprops = revprops or {}
 
271
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
 
272
        self.config_stack = config or self.config_stack
 
273
        return operation.run(
 
274
               message=message,
 
275
               timestamp=timestamp,
 
276
               timezone=timezone,
 
277
               committer=committer,
 
278
               specific_files=specific_files,
 
279
               rev_id=rev_id,
 
280
               allow_pointless=allow_pointless,
 
281
               strict=strict,
 
282
               verbose=verbose,
 
283
               working_tree=working_tree,
 
284
               local=local,
 
285
               reporter=reporter,
 
286
               message_callback=message_callback,
 
287
               recursive=recursive,
 
288
               exclude=exclude,
 
289
               possible_master_transports=possible_master_transports,
 
290
               lossy=lossy)
 
291
 
 
292
    def _commit(self, operation, message, timestamp, timezone, committer,
 
293
            specific_files, rev_id, allow_pointless, strict, verbose,
 
294
            working_tree, local, reporter, message_callback, recursive,
 
295
            exclude, possible_master_transports, lossy):
171
296
        mutter('preparing to commit')
172
297
 
173
 
        self.branch = branch
174
 
        self.weave_store = branch.weave_store
175
 
        self.rev_id = rev_id
176
 
        self.specific_files = specific_files
 
298
        if working_tree is None:
 
299
            raise BzrError("working_tree must be passed into commit().")
 
300
        else:
 
301
            self.work_tree = working_tree
 
302
            self.branch = self.work_tree.branch
 
303
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
304
                if not self.branch.repository.supports_rich_root():
 
305
                    raise errors.RootNotRich()
 
306
        if message_callback is None:
 
307
            if message is not None:
 
308
                if isinstance(message, str):
 
309
                    message = message.decode(get_user_encoding())
 
310
                message_callback = lambda x: message
 
311
            else:
 
312
                raise BzrError("The message or message_callback keyword"
 
313
                               " parameter is required for commit().")
 
314
 
 
315
        self.bound_branch = None
 
316
        self.any_entries_deleted = False
 
317
        if exclude is not None:
 
318
            self.exclude = sorted(
 
319
                minimum_path_selection(exclude))
 
320
        else:
 
321
            self.exclude = []
 
322
        self.local = local
 
323
        self.master_branch = None
 
324
        self.recursive = recursive
 
325
        self.rev_id = None
 
326
        # self.specific_files is None to indicate no filter, or any iterable to
 
327
        # indicate a filter - [] means no files at all, as per iter_changes.
 
328
        if specific_files is not None:
 
329
            self.specific_files = sorted(
 
330
                minimum_path_selection(specific_files))
 
331
        else:
 
332
            self.specific_files = None
 
333
 
177
334
        self.allow_pointless = allow_pointless
178
 
 
179
 
        if timestamp is None:
180
 
            self.timestamp = time.time()
181
 
        else:
182
 
            self.timestamp = long(timestamp)
183
 
            
184
 
        if rev_id is None:
185
 
            self.rev_id = _gen_revision_id(self.branch, self.timestamp)
186
 
        else:
187
 
            self.rev_id = rev_id
188
 
 
189
 
        if committer is None:
190
 
            self.committer = username(self.branch)
191
 
        else:
192
 
            assert isinstance(committer, basestring), type(committer)
193
 
            self.committer = committer
194
 
 
195
 
        if timezone is None:
196
 
            self.timezone = local_time_offset()
197
 
        else:
198
 
            self.timezone = int(timezone)
199
 
 
200
 
        assert isinstance(message, basestring), type(message)
201
 
        self.message = message
202
 
        self._escape_commit_message()
203
 
 
204
 
        self.branch.lock_write()
205
 
        try:
206
 
            self.work_tree = self.branch.working_tree()
207
 
            self.work_inv = self.work_tree.inventory
208
 
            self.basis_tree = self.branch.basis_tree()
209
 
            self.basis_inv = self.basis_tree.inventory
210
 
 
211
 
            self._gather_parents()
212
 
            if len(self.parents) > 1 and self.specific_files:
213
 
                raise NotImplementedError('selected-file commit of merges is not supported yet')
214
 
            self._check_parents_present()
215
 
            
216
 
            self._remove_deleted()
217
 
            self._populate_new_inv()
218
 
            self._store_snapshot()
219
 
            self._report_deletes()
220
 
 
221
 
            if not (self.allow_pointless
222
 
                    or len(self.parents) > 1
223
 
                    or self.new_inv != self.basis_inv):
224
 
                raise PointlessCommit()
225
 
 
226
 
            self._record_inventory()
227
 
            self._record_ancestry()
228
 
            self._make_revision()
229
 
            note('committed r%d {%s}', (self.branch.revno() + 1),
230
 
                 self.rev_id)
231
 
            self.branch.append_revision(self.rev_id)
232
 
            self.branch.set_pending_merges([])
233
 
        finally:
234
 
            self.branch.unlock()
235
 
 
236
 
    def _record_inventory(self):
237
 
        """Store the inventory for the new revision."""
238
 
        inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
239
 
        self.inv_sha1 = sha_string(inv_text)
240
 
        s = self.branch.control_weaves
241
 
        s.add_text('inventory', self.rev_id,
242
 
                   split_lines(inv_text), self.present_parents)
243
 
 
244
 
    def _escape_commit_message(self):
245
 
        """Replace xml-incompatible control characters."""
246
 
        # Python strings can include characters that can't be
247
 
        # represented in well-formed XML; escape characters that
248
 
        # aren't listed in the XML specification
249
 
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
250
 
        if isinstance(self.message, unicode):
251
 
            char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
252
 
        else:
253
 
            # Use a regular 'str' as pattern to avoid having re.subn
254
 
            # return 'unicode' results.
255
 
            char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
256
 
        self.message, escape_count = re.subn(
257
 
            char_pattern,
258
 
            lambda match: match.group(0).encode('unicode_escape'),
259
 
            self.message)
260
 
        if escape_count:
261
 
            note("replaced %d control characters in message", escape_count)
262
 
 
263
 
    def _record_ancestry(self):
264
 
        """Append merged revision ancestry to the ancestry file.
265
 
 
266
 
        This should be the merged ancestry of all parents, plus the
267
 
        new revision id."""
268
 
        s = self.branch.control_weaves
269
 
        w = s.get_weave_or_empty('ancestry')
270
 
        lines = self._make_ancestry(w)
271
 
        w.add(self.rev_id, self.present_parents, lines)
272
 
        s.put_weave('ancestry', w)
273
 
 
274
 
    def _make_ancestry(self, ancestry_weave):
275
 
        """Return merged ancestry lines.
276
 
 
277
 
        The lines are revision-ids followed by newlines."""
278
 
        parent_ancestries = [ancestry_weave.get(p) for p in self.present_parents]
279
 
        new_lines = merge_ancestry_lines(self.rev_id, parent_ancestries)
280
 
        mutter('merged ancestry of {%s}:\n%s', self.rev_id, ''.join(new_lines))
281
 
        return new_lines
 
335
        self.message_callback = message_callback
 
336
        self.timestamp = timestamp
 
337
        self.timezone = timezone
 
338
        self.committer = committer
 
339
        self.strict = strict
 
340
        self.verbose = verbose
 
341
 
 
342
        self.work_tree.lock_write()
 
343
        operation.add_cleanup(self.work_tree.unlock)
 
344
        self.parents = self.work_tree.get_parent_ids()
 
345
        # We can use record_iter_changes IFF iter_changes is compatible with
 
346
        # the command line parameters, and the repository has fast delta
 
347
        # generation. See bug 347649.
 
348
        self.use_record_iter_changes = (
 
349
            not self.exclude and 
 
350
            not self.branch.repository._format.supports_tree_reference and
 
351
            (self.branch.repository._format.fast_deltas or
 
352
             len(self.parents) < 2))
 
353
        self.pb = ui.ui_factory.nested_progress_bar()
 
354
        operation.add_cleanup(self.pb.finished)
 
355
        self.basis_revid = self.work_tree.last_revision()
 
356
        self.basis_tree = self.work_tree.basis_tree()
 
357
        self.basis_tree.lock_read()
 
358
        operation.add_cleanup(self.basis_tree.unlock)
 
359
        # Cannot commit with conflicts present.
 
360
        if len(self.work_tree.conflicts()) > 0:
 
361
            raise ConflictsInTree
 
362
 
 
363
        # Setup the bound branch variables as needed.
 
364
        self._check_bound_branch(operation, possible_master_transports)
 
365
 
 
366
        # Check that the working tree is up to date
 
367
        old_revno, old_revid, new_revno = self._check_out_of_date_tree()
 
368
 
 
369
        # Complete configuration setup
 
370
        if reporter is not None:
 
371
            self.reporter = reporter
 
372
        elif self.reporter is None:
 
373
            self.reporter = self._select_reporter()
 
374
        if self.config_stack is None:
 
375
            self.config_stack = self.work_tree.get_config_stack()
 
376
 
 
377
        self._set_specific_file_ids()
 
378
 
 
379
        # Setup the progress bar. As the number of files that need to be
 
380
        # committed in unknown, progress is reported as stages.
 
381
        # We keep track of entries separately though and include that
 
382
        # information in the progress bar during the relevant stages.
 
383
        self.pb_stage_name = ""
 
384
        self.pb_stage_count = 0
 
385
        self.pb_stage_total = 5
 
386
        if self.bound_branch:
 
387
            # 2 extra stages: "Uploading data to master branch" and "Merging
 
388
            # tags to master branch"
 
389
            self.pb_stage_total += 2
 
390
        self.pb.show_pct = False
 
391
        self.pb.show_spinner = False
 
392
        self.pb.show_eta = False
 
393
        self.pb.show_count = True
 
394
        self.pb.show_bar = True
 
395
 
 
396
        self._gather_parents()
 
397
        # After a merge, a selected file commit is not supported.
 
398
        # See 'bzr help merge' for an explanation as to why.
 
399
        if len(self.parents) > 1 and self.specific_files is not None:
 
400
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
401
        # Excludes are a form of selected file commit.
 
402
        if len(self.parents) > 1 and self.exclude:
 
403
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
404
 
 
405
        # Collect the changes
 
406
        self._set_progress_stage("Collecting changes", counter=True)
 
407
        self._lossy = lossy
 
408
        self.builder = self.branch.get_commit_builder(self.parents,
 
409
            self.config_stack, timestamp, timezone, committer, self.revprops,
 
410
            rev_id, lossy=lossy)
 
411
        if not self.builder.supports_record_entry_contents and self.exclude:
 
412
            self.builder.abort()
 
413
            raise errors.ExcludesUnsupported(self.branch.repository)
 
414
 
 
415
        if self.builder.updates_branch and self.bound_branch:
 
416
            self.builder.abort()
 
417
            raise AssertionError(
 
418
                "bound branches not supported for commit builders "
 
419
                "that update the branch")
 
420
 
 
421
        try:
 
422
            self.builder.will_record_deletes()
 
423
            # find the location being committed to
 
424
            if self.bound_branch:
 
425
                master_location = self.master_branch.base
 
426
            else:
 
427
                master_location = self.branch.base
 
428
 
 
429
            # report the start of the commit
 
430
            self.reporter.started(new_revno, self.rev_id, master_location)
 
431
 
 
432
            self._update_builder_with_changes()
 
433
            self._check_pointless()
 
434
 
 
435
            # TODO: Now the new inventory is known, check for conflicts.
 
436
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
437
            # weave lines, because nothing should be recorded until it is known
 
438
            # that commit will succeed.
 
439
            self._set_progress_stage("Saving data locally")
 
440
            self.builder.finish_inventory()
 
441
 
 
442
            # Prompt the user for a commit message if none provided
 
443
            message = message_callback(self)
 
444
            self.message = message
 
445
 
 
446
            # Add revision data to the local branch
 
447
            self.rev_id = self.builder.commit(self.message)
 
448
 
 
449
        except Exception, e:
 
450
            mutter("aborting commit write group because of exception:")
 
451
            trace.log_exception_quietly()
 
452
            self.builder.abort()
 
453
            raise
 
454
 
 
455
        self._update_branches(old_revno, old_revid, new_revno)
 
456
 
 
457
        # Make the working tree be up to date with the branch. This
 
458
        # includes automatic changes scheduled to be made to the tree, such
 
459
        # as updating its basis and unversioning paths that were missing.
 
460
        self.work_tree.unversion(self.deleted_ids)
 
461
        self._set_progress_stage("Updating the working tree")
 
462
        self.work_tree.update_basis_by_delta(self.rev_id,
 
463
             self.builder.get_basis_delta())
 
464
        self.reporter.completed(new_revno, self.rev_id)
 
465
        self._process_post_hooks(old_revno, new_revno)
 
466
        return self.rev_id
 
467
 
 
468
    def _update_branches(self, old_revno, old_revid, new_revno):
 
469
        """Update the master and local branch to the new revision.
 
470
 
 
471
        This will try to make sure that the master branch is updated
 
472
        before the local branch.
 
473
 
 
474
        :param old_revno: Revision number of master branch before the
 
475
            commit
 
476
        :param old_revid: Tip of master branch before the commit
 
477
        :param new_revno: Revision number of the new commit
 
478
        """
 
479
        if not self.builder.updates_branch:
 
480
            self._process_pre_hooks(old_revno, new_revno)
 
481
 
 
482
            # Upload revision data to the master.
 
483
            # this will propagate merged revisions too if needed.
 
484
            if self.bound_branch:
 
485
                self._set_progress_stage("Uploading data to master branch")
 
486
                # 'commit' to the master first so a timeout here causes the
 
487
                # local branch to be out of date
 
488
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
 
489
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
 
490
                if self._lossy:
 
491
                    self.branch.fetch(self.master_branch, self.rev_id)
 
492
 
 
493
            # and now do the commit locally.
 
494
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
495
        else:
 
496
            try:
 
497
                self._process_pre_hooks(old_revno, new_revno)
 
498
            except:
 
499
                # The commit builder will already have updated the branch,
 
500
                # revert it.
 
501
                self.branch.set_last_revision_info(old_revno, old_revid)
 
502
                raise
 
503
 
 
504
        # Merge local tags to remote
 
505
        if self.bound_branch:
 
506
            self._set_progress_stage("Merging tags to master branch")
 
507
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
 
508
                self.master_branch.tags)
 
509
            if tag_conflicts:
 
510
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
 
511
                note( gettext("Conflicting tags in bound branch:\n{0}".format(
 
512
                    "\n".join(warning_lines))) )
 
513
 
 
514
    def _select_reporter(self):
 
515
        """Select the CommitReporter to use."""
 
516
        if is_quiet():
 
517
            return NullCommitReporter()
 
518
        return ReportCommitToLog()
 
519
 
 
520
    def _check_pointless(self):
 
521
        if self.allow_pointless:
 
522
            return
 
523
        # A merge with no effect on files
 
524
        if len(self.parents) > 1:
 
525
            return
 
526
        if self.builder.any_changes():
 
527
            return
 
528
        raise PointlessCommit()
 
529
 
 
530
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
531
        """Check to see if the local branch is bound.
 
532
 
 
533
        If it is bound, then most of the commit will actually be
 
534
        done using the remote branch as the target branch.
 
535
        Only at the end will the local branch be updated.
 
536
        """
 
537
        if self.local and not self.branch.get_bound_location():
 
538
            raise errors.LocalRequiresBoundBranch()
 
539
 
 
540
        if not self.local:
 
541
            self.master_branch = self.branch.get_master_branch(
 
542
                possible_master_transports)
 
543
 
 
544
        if not self.master_branch:
 
545
            # make this branch the reference branch for out of date checks.
 
546
            self.master_branch = self.branch
 
547
            return
 
548
 
 
549
        # If the master branch is bound, we must fail
 
550
        master_bound_location = self.master_branch.get_bound_location()
 
551
        if master_bound_location:
 
552
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
553
                    self.master_branch, master_bound_location)
 
554
 
 
555
        # TODO: jam 20051230 We could automatically push local
 
556
        #       commits to the remote branch if they would fit.
 
557
        #       But for now, just require remote to be identical
 
558
        #       to local.
 
559
 
 
560
        # Make sure the local branch is identical to the master
 
561
        master_info = self.master_branch.last_revision_info()
 
562
        local_info = self.branch.last_revision_info()
 
563
        if local_info != master_info:
 
564
            raise errors.BoundBranchOutOfDate(self.branch,
 
565
                    self.master_branch)
 
566
 
 
567
        # Now things are ready to change the master branch
 
568
        # so grab the lock
 
569
        self.bound_branch = self.branch
 
570
        self.master_branch.lock_write()
 
571
        operation.add_cleanup(self.master_branch.unlock)
 
572
 
 
573
    def _check_out_of_date_tree(self):
 
574
        """Check that the working tree is up to date.
 
575
 
 
576
        :return: old_revision_number, old_revision_id, new_revision_number
 
577
            tuple
 
578
        """
 
579
        try:
 
580
            first_tree_parent = self.work_tree.get_parent_ids()[0]
 
581
        except IndexError:
 
582
            # if there are no parents, treat our parent as 'None'
 
583
            # this is so that we still consider the master branch
 
584
            # - in a checkout scenario the tree may have no
 
585
            # parents but the branch may do.
 
586
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
587
        old_revno, master_last = self.master_branch.last_revision_info()
 
588
        if master_last != first_tree_parent:
 
589
            if master_last != bzrlib.revision.NULL_REVISION:
 
590
                raise errors.OutOfDateTree(self.work_tree)
 
591
        if self.branch.repository.has_revision(first_tree_parent):
 
592
            new_revno = old_revno + 1
 
593
        else:
 
594
            # ghost parents never appear in revision history.
 
595
            new_revno = 1
 
596
        return old_revno, master_last, new_revno
 
597
 
 
598
    def _process_pre_hooks(self, old_revno, new_revno):
 
599
        """Process any registered pre commit hooks."""
 
600
        self._set_progress_stage("Running pre_commit hooks")
 
601
        self._process_hooks("pre_commit", old_revno, new_revno)
 
602
 
 
603
    def _process_post_hooks(self, old_revno, new_revno):
 
604
        """Process any registered post commit hooks."""
 
605
        # Process the post commit hooks, if any
 
606
        self._set_progress_stage("Running post_commit hooks")
 
607
        # old style commit hooks - should be deprecated ? (obsoleted in
 
608
        # 0.15^H^H^H^H 2.5.0)
 
609
        post_commit = self.config_stack.get('post_commit')
 
610
        if post_commit is not None:
 
611
            hooks = post_commit.split(' ')
 
612
            # this would be nicer with twisted.python.reflect.namedAny
 
613
            for hook in hooks:
 
614
                result = eval(hook + '(branch, rev_id)',
 
615
                              {'branch':self.branch,
 
616
                               'bzrlib':bzrlib,
 
617
                               'rev_id':self.rev_id})
 
618
        # process new style post commit hooks
 
619
        self._process_hooks("post_commit", old_revno, new_revno)
 
620
 
 
621
    def _process_hooks(self, hook_name, old_revno, new_revno):
 
622
        if not Branch.hooks[hook_name]:
 
623
            return
 
624
 
 
625
        # new style commit hooks:
 
626
        if not self.bound_branch:
 
627
            hook_master = self.branch
 
628
            hook_local = None
 
629
        else:
 
630
            hook_master = self.master_branch
 
631
            hook_local = self.branch
 
632
        # With bound branches, when the master is behind the local branch,
 
633
        # the 'old_revno' and old_revid values here are incorrect.
 
634
        # XXX: FIXME ^. RBC 20060206
 
635
        if self.parents:
 
636
            old_revid = self.parents[0]
 
637
        else:
 
638
            old_revid = bzrlib.revision.NULL_REVISION
 
639
 
 
640
        if hook_name == "pre_commit":
 
641
            future_tree = self.builder.revision_tree()
 
642
            tree_delta = future_tree.changes_from(self.basis_tree,
 
643
                                             include_root=True)
 
644
 
 
645
        for hook in Branch.hooks[hook_name]:
 
646
            # show the running hook in the progress bar. As hooks may
 
647
            # end up doing nothing (e.g. because they are not configured by
 
648
            # the user) this is still showing progress, not showing overall
 
649
            # actions - its up to each plugin to show a UI if it want's to
 
650
            # (such as 'Emailing diff to foo@example.com').
 
651
            self.pb_stage_name = "Running %s hooks [%s]" % \
 
652
                (hook_name, Branch.hooks.get_hook_name(hook))
 
653
            self._emit_progress()
 
654
            if 'hooks' in debug.debug_flags:
 
655
                mutter("Invoking commit hook: %r", hook)
 
656
            if hook_name == "post_commit":
 
657
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
658
                     self.rev_id)
 
659
            elif hook_name == "pre_commit":
 
660
                hook(hook_local, hook_master,
 
661
                     old_revno, old_revid, new_revno, self.rev_id,
 
662
                     tree_delta, future_tree)
282
663
 
283
664
    def _gather_parents(self):
284
665
        """Record the parents of a merge for merge detection."""
285
 
        pending_merges = self.branch.pending_merges()
286
 
        self.parents = []
287
 
        self.parent_trees = []
288
 
        self.present_parents = []
289
 
        precursor_id = self.branch.last_revision()
290
 
        if precursor_id:
291
 
            self.parents.append(precursor_id)
292
 
        self.parents += pending_merges
293
 
        for revision in self.parents:
294
 
            if self.branch.has_revision(revision):
295
 
                self.parent_trees.append(self.branch.revision_tree(revision))
296
 
                self.present_parents.append(revision)
297
 
 
298
 
    def _check_parents_present(self):
299
 
        for parent_id in self.parents:
300
 
            mutter('commit parent revision {%s}', parent_id)
301
 
            if not self.branch.has_revision(parent_id):
302
 
                if parent_id == self.branch.last_revision():
303
 
                    warning("parent is pissing %r", parent_id)
304
 
                    raise HistoryMissing(self.branch, 'revision', parent_id)
 
666
        # TODO: Make sure that this list doesn't contain duplicate
 
667
        # entries and the order is preserved when doing this.
 
668
        if self.use_record_iter_changes:
 
669
            return
 
670
        self.basis_inv = self.basis_tree.root_inventory
 
671
        self.parent_invs = [self.basis_inv]
 
672
        for revision in self.parents[1:]:
 
673
            if self.branch.repository.has_revision(revision):
 
674
                mutter('commit parent revision {%s}', revision)
 
675
                inventory = self.branch.repository.get_inventory(revision)
 
676
                self.parent_invs.append(inventory)
 
677
            else:
 
678
                mutter('commit parent ghost revision {%s}', revision)
 
679
 
 
680
    def _update_builder_with_changes(self):
 
681
        """Update the commit builder with the data about what has changed.
 
682
        """
 
683
        exclude = self.exclude
 
684
        specific_files = self.specific_files
 
685
        mutter("Selecting files for commit with filter %s", specific_files)
 
686
 
 
687
        self._check_strict()
 
688
        if self.use_record_iter_changes:
 
689
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
690
                specific_files=specific_files)
 
691
            iter_changes = self._filter_iter_changes(iter_changes)
 
692
            for file_id, path, fs_hash in self.builder.record_iter_changes(
 
693
                self.work_tree, self.basis_revid, iter_changes):
 
694
                self.work_tree._observed_sha1(file_id, path, fs_hash)
 
695
        else:
 
696
            # Build the new inventory
 
697
            self._populate_from_inventory()
 
698
            self._record_unselected()
 
699
            self._report_and_accumulate_deletes()
 
700
 
 
701
    def _filter_iter_changes(self, iter_changes):
 
702
        """Process iter_changes.
 
703
 
 
704
        This method reports on the changes in iter_changes to the user, and 
 
705
        converts 'missing' entries in the iter_changes iterator to 'deleted'
 
706
        entries. 'missing' entries have their
 
707
 
 
708
        :param iter_changes: An iter_changes to process.
 
709
        :return: A generator of changes.
 
710
        """
 
711
        reporter = self.reporter
 
712
        report_changes = reporter.is_verbose()
 
713
        deleted_ids = []
 
714
        for change in iter_changes:
 
715
            if report_changes:
 
716
                old_path = change[1][0]
 
717
                new_path = change[1][1]
 
718
                versioned = change[3][1]
 
719
            kind = change[6][1]
 
720
            versioned = change[3][1]
 
721
            if kind is None and versioned:
 
722
                # 'missing' path
 
723
                if report_changes:
 
724
                    reporter.missing(new_path)
 
725
                deleted_ids.append(change[0])
 
726
                # Reset the new path (None) and new versioned flag (False)
 
727
                change = (change[0], (change[1][0], None), change[2],
 
728
                    (change[3][0], False)) + change[4:]
 
729
                new_path = change[1][1]
 
730
                versioned = False
 
731
            elif kind == 'tree-reference':
 
732
                if self.recursive == 'down':
 
733
                    self._commit_nested_tree(change[0], change[1][1])
 
734
            if change[3][0] or change[3][1]:
 
735
                yield change
 
736
                if report_changes:
 
737
                    if new_path is None:
 
738
                        reporter.deleted(old_path)
 
739
                    elif old_path is None:
 
740
                        reporter.snapshot_change(gettext('added'), new_path)
 
741
                    elif old_path != new_path:
 
742
                        reporter.renamed(gettext('renamed'), old_path, new_path)
 
743
                    else:
 
744
                        if (new_path or 
 
745
                            self.work_tree.branch.repository._format.rich_root_data):
 
746
                            # Don't report on changes to '' in non rich root
 
747
                            # repositories.
 
748
                            reporter.snapshot_change(gettext('modified'), new_path)
 
749
            self._next_progress_entry()
 
750
        # Unversion IDs that were found to be deleted
 
751
        self.deleted_ids = deleted_ids
 
752
 
 
753
    def _record_unselected(self):
 
754
        # If specific files are selected, then all un-selected files must be
 
755
        # recorded in their previous state. For more details, see
 
756
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
757
        if self.specific_files or self.exclude:
 
758
            specific_files = self.specific_files or []
 
759
            for path, old_ie in self.basis_inv.iter_entries():
 
760
                if self.builder.new_inventory.has_id(old_ie.file_id):
 
761
                    # already added - skip.
 
762
                    continue
 
763
                if (is_inside_any(specific_files, path)
 
764
                    and not is_inside_any(self.exclude, path)):
 
765
                    # was inside the selected path, and not excluded - if not
 
766
                    # present it has been deleted so skip.
 
767
                    continue
 
768
                # From here down it was either not selected, or was excluded:
 
769
                # We preserve the entry unaltered.
 
770
                ie = old_ie.copy()
 
771
                # Note: specific file commits after a merge are currently
 
772
                # prohibited. This test is for sanity/safety in case it's
 
773
                # required after that changes.
 
774
                if len(self.parents) > 1:
 
775
                    ie.revision = None
 
776
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
777
                    self.basis_tree, None)
 
778
 
 
779
    def _report_and_accumulate_deletes(self):
 
780
        if (isinstance(self.basis_inv, Inventory)
 
781
            and isinstance(self.builder.new_inventory, Inventory)):
 
782
            # the older Inventory classes provide a _byid dict, and building a
 
783
            # set from the keys of this dict is substantially faster than even
 
784
            # getting a set of ids from the inventory
 
785
            #
 
786
            # <lifeless> set(dict) is roughly the same speed as
 
787
            # set(iter(dict)) and both are significantly slower than
 
788
            # set(dict.keys())
 
789
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
790
               set(self.builder.new_inventory._byid.keys())
 
791
        else:
 
792
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
793
        if deleted_ids:
 
794
            self.any_entries_deleted = True
 
795
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
796
                for file_id in deleted_ids]
 
797
            deleted.sort()
 
798
            # XXX: this is not quite directory-order sorting
 
799
            for path, file_id in deleted:
 
800
                self.builder.record_delete(path, file_id)
 
801
                self.reporter.deleted(path)
 
802
 
 
803
    def _check_strict(self):
 
804
        # XXX: when we use iter_changes this would likely be faster if
 
805
        # iter_changes would check for us (even in the presence of
 
806
        # selected_files).
 
807
        if self.strict:
 
808
            # raise an exception as soon as we find a single unknown.
 
809
            for unknown in self.work_tree.unknowns():
 
810
                raise StrictCommitFailed()
 
811
 
 
812
    def _populate_from_inventory(self):
 
813
        """Populate the CommitBuilder by walking the working tree inventory."""
 
814
        # Build the revision inventory.
 
815
        #
 
816
        # This starts by creating a new empty inventory. Depending on
 
817
        # which files are selected for commit, and what is present in the
 
818
        # current tree, the new inventory is populated. inventory entries
 
819
        # which are candidates for modification have their revision set to
 
820
        # None; inventory entries that are carried over untouched have their
 
821
        # revision set to their prior value.
 
822
        #
 
823
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
824
        # results to create a new inventory at the same time, which results
 
825
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
826
        # ADHB 11-07-2006
 
827
 
 
828
        specific_files = self.specific_files
 
829
        exclude = self.exclude
 
830
        report_changes = self.reporter.is_verbose()
 
831
        deleted_ids = []
 
832
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
833
        # deleted, then we have {'foo':{'bar':{}}}
 
834
        deleted_paths = {}
 
835
        # XXX: Note that entries may have the wrong kind because the entry does
 
836
        # not reflect the status on disk.
 
837
        # NB: entries will include entries within the excluded ids/paths
 
838
        # because iter_entries_by_dir has no 'exclude' facility today.
 
839
        entries = self.work_tree.iter_entries_by_dir(
 
840
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
841
        for path, existing_ie in entries:
 
842
            file_id = existing_ie.file_id
 
843
            name = existing_ie.name
 
844
            parent_id = existing_ie.parent_id
 
845
            kind = existing_ie.kind
 
846
            # Skip files that have been deleted from the working tree.
 
847
            # The deleted path ids are also recorded so they can be explicitly
 
848
            # unversioned later.
 
849
            if deleted_paths:
 
850
                path_segments = splitpath(path)
 
851
                deleted_dict = deleted_paths
 
852
                for segment in path_segments:
 
853
                    deleted_dict = deleted_dict.get(segment, None)
 
854
                    if not deleted_dict:
 
855
                        # We either took a path not present in the dict
 
856
                        # (deleted_dict was None), or we've reached an empty
 
857
                        # child dir in the dict, so are now a sub-path.
 
858
                        break
305
859
                else:
306
 
                    mutter("commit will ghost revision %r", parent_id)
307
 
            
308
 
    def _make_revision(self):
309
 
        """Record a new revision object for this commit."""
310
 
        self.rev = Revision(timestamp=self.timestamp,
311
 
                            timezone=self.timezone,
312
 
                            committer=self.committer,
313
 
                            message=self.message,
314
 
                            inventory_sha1=self.inv_sha1,
315
 
                            revision_id=self.rev_id)
316
 
        self.rev.parent_ids = self.parents
317
 
        rev_tmp = StringIO()
318
 
        serializer_v5.write_revision(self.rev, rev_tmp)
319
 
        rev_tmp.seek(0)
320
 
        self.branch.revision_store.add(rev_tmp, self.rev_id)
321
 
        mutter('new revision_id is {%s}', self.rev_id)
322
 
 
323
 
 
324
 
    def _remove_deleted(self):
325
 
        """Remove deleted files from the working inventories.
326
 
 
327
 
        This is done prior to taking the working inventory as the
328
 
        basis for the new committed inventory.
329
 
 
330
 
        This returns true if any files
331
 
        *that existed in the basis inventory* were deleted.
332
 
        Files that were added and deleted
333
 
        in the working copy don't matter.
334
 
        """
335
 
        specific = self.specific_files
336
 
        deleted_ids = []
337
 
        for path, ie in self.work_inv.iter_entries():
338
 
            if specific and not is_inside_any(specific, path):
 
860
                    deleted_dict = None
 
861
                if deleted_dict is not None:
 
862
                    # the path has a deleted parent, do not add it.
 
863
                    continue
 
864
            if exclude and is_inside_any(exclude, path):
 
865
                # Skip excluded paths. Excluded paths are processed by
 
866
                # _update_builder_with_changes.
339
867
                continue
340
 
            if not self.work_tree.has_filename(path):
341
 
                note('missing %s', path)
342
 
                deleted_ids.append((path, ie.file_id))
343
 
        if deleted_ids:
344
 
            deleted_ids.sort(reverse=True)
345
 
            for path, file_id in deleted_ids:
346
 
                del self.work_inv[file_id]
347
 
            self.branch._write_inventory(self.work_inv)
348
 
 
349
 
 
350
 
    def _find_entry_parents(self, file_id):
351
 
        """Return the text versions and hashes for all file parents.
352
 
 
353
 
        Returned as a map from text version to inventory entry.
354
 
 
355
 
        This is a set containing the file versions in all parents
356
 
        revisions containing the file.  If the file is new, the set
357
 
        will be empty."""
358
 
        r = {}
359
 
        for tree in self.parent_trees:
360
 
            if file_id in tree.inventory:
361
 
                ie = tree.inventory[file_id]
362
 
                assert ie.file_id == file_id
363
 
                if ie.revision in r:
364
 
                    assert r[ie.revision] == ie
 
868
            content_summary = self.work_tree.path_content_summary(path)
 
869
            kind = content_summary[0]
 
870
            # Note that when a filter of specific files is given, we must only
 
871
            # skip/record deleted files matching that filter.
 
872
            if not specific_files or is_inside_any(specific_files, path):
 
873
                if kind == 'missing':
 
874
                    if not deleted_paths:
 
875
                        # path won't have been split yet.
 
876
                        path_segments = splitpath(path)
 
877
                    deleted_dict = deleted_paths
 
878
                    for segment in path_segments:
 
879
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
880
                    self.reporter.missing(path)
 
881
                    self._next_progress_entry()
 
882
                    deleted_ids.append(file_id)
 
883
                    continue
 
884
            # TODO: have the builder do the nested commit just-in-time IF and
 
885
            # only if needed.
 
886
            if kind == 'tree-reference':
 
887
                # enforce repository nested tree policy.
 
888
                if (not self.work_tree.supports_tree_reference() or
 
889
                    # repository does not support it either.
 
890
                    not self.branch.repository._format.supports_tree_reference):
 
891
                    kind = 'directory'
 
892
                    content_summary = (kind, None, None, None)
 
893
                elif self.recursive == 'down':
 
894
                    nested_revision_id = self._commit_nested_tree(
 
895
                        file_id, path)
 
896
                    content_summary = (kind, None, None, nested_revision_id)
365
897
                else:
366
 
                    r[ie.revision] = ie
367
 
        return r
368
 
 
369
 
    def _store_snapshot(self):
370
 
        """Pass over inventory and record a snapshot.
371
 
 
372
 
        Entries get a new revision when they are modified in 
373
 
        any way, which includes a merge with a new set of
374
 
        parents that have the same entry. Currently we do not
375
 
        check for that set being ancestors of each other - and
376
 
        we should - only parallel children should count for this
377
 
        test see find_entry_parents to correct this. FIXME <---
378
 
        I.e. if we are merging in revision FOO, and our
379
 
        copy of file id BAR is identical to FOO.BAR, we should
380
 
        generate a new revision of BAR IF and only IF FOO is
381
 
        neither a child of our current tip, nor an ancestor of
382
 
        our tip. The presence of FOO in our store should not 
383
 
        affect this logic UNLESS we are doing a merge of FOO,
384
 
        or a child of FOO.
385
 
        """
386
 
        # XXX: Need to think more here about when the user has
387
 
        # made a specific decision on a particular value -- c.f.
388
 
        # mark-merge.  
389
 
        for path, ie in self.new_inv.iter_entries():
390
 
            previous_entries = self._find_entry_parents(ie. file_id)
391
 
            if ie.revision is None:
392
 
                change = ie.snapshot(self.rev_id, path, previous_entries,
393
 
                                     self.work_tree, self.weave_store)
394
 
            else:
395
 
                change = "unchanged"
396
 
            note("%s %s", change, path)
397
 
 
398
 
    def _populate_new_inv(self):
399
 
        """Build revision inventory.
400
 
 
401
 
        This creates a new empty inventory. Depending on
402
 
        which files are selected for commit, and what is present in the
403
 
        current tree, the new inventory is populated. inventory entries 
404
 
        which are candidates for modification have their revision set to
405
 
        None; inventory entries that are carried over untouched have their
406
 
        revision set to their prior value.
407
 
        """
408
 
        mutter("Selecting files for commit with filter %s", self.specific_files)
409
 
        self.new_inv = Inventory()
410
 
        for path, new_ie in self.work_inv.iter_entries():
411
 
            file_id = new_ie.file_id
412
 
            mutter('check %s {%s}', path, new_ie.file_id)
413
 
            if self.specific_files:
414
 
                if not is_inside_any(self.specific_files, path):
415
 
                    mutter('%s not selected for commit', path)
416
 
                    self._carry_file(file_id)
417
 
                    continue
418
 
            mutter('%s selected for commit', path)
419
 
            ie = new_ie.copy()
 
898
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
899
                    content_summary = (kind, None, None, nested_revision_id)
 
900
 
 
901
            # Record an entry for this item
 
902
            # Note: I don't particularly want to have the existing_ie
 
903
            # parameter but the test suite currently (28-Jun-07) breaks
 
904
            # without it thanks to a unicode normalisation issue. :-(
 
905
            definitely_changed = kind != existing_ie.kind
 
906
            self._record_entry(path, file_id, specific_files, kind, name,
 
907
                parent_id, definitely_changed, existing_ie, report_changes,
 
908
                content_summary)
 
909
 
 
910
        # Unversion IDs that were found to be deleted
 
911
        self.deleted_ids = deleted_ids
 
912
 
 
913
    def _commit_nested_tree(self, file_id, path):
 
914
        "Commit a nested tree."
 
915
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
 
916
        # FIXME: be more comprehensive here:
 
917
        # this works when both trees are in --trees repository,
 
918
        # but when both are bound to a different repository,
 
919
        # it fails; a better way of approaching this is to
 
920
        # finally implement the explicit-caches approach design
 
921
        # a while back - RBC 20070306.
 
922
        if sub_tree.branch.repository.has_same_location(
 
923
            self.work_tree.branch.repository):
 
924
            sub_tree.branch.repository = \
 
925
                self.work_tree.branch.repository
 
926
        try:
 
927
            return sub_tree.commit(message=None, revprops=self.revprops,
 
928
                recursive=self.recursive,
 
929
                message_callback=self.message_callback,
 
930
                timestamp=self.timestamp, timezone=self.timezone,
 
931
                committer=self.committer,
 
932
                allow_pointless=self.allow_pointless,
 
933
                strict=self.strict, verbose=self.verbose,
 
934
                local=self.local, reporter=self.reporter)
 
935
        except errors.PointlessCommit:
 
936
            return self.work_tree.get_reference_revision(file_id)
 
937
 
 
938
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
939
        parent_id, definitely_changed, existing_ie, report_changes,
 
940
        content_summary):
 
941
        "Record the new inventory entry for a path if any."
 
942
        # mutter('check %s {%s}', path, file_id)
 
943
        # mutter('%s selected for commit', path)
 
944
        if definitely_changed or existing_ie is None:
 
945
            ie = make_entry(kind, name, parent_id, file_id)
 
946
        else:
 
947
            ie = existing_ie.copy()
420
948
            ie.revision = None
421
 
            self.new_inv.add(ie)
422
 
 
423
 
    def _carry_file(self, file_id):
424
 
        """Carry the file unchanged from the basis revision."""
425
 
        if self.basis_inv.has_id(file_id):
426
 
            self.new_inv.add(self.basis_inv[file_id].copy())
427
 
 
428
 
    def _report_deletes(self):
429
 
        for file_id in self.basis_inv:
430
 
            if file_id not in self.new_inv:
431
 
                note('deleted %s', self.basis_inv.id2path(file_id))
432
 
 
433
 
 
434
 
 
435
 
def _gen_revision_id(branch, when):
436
 
    """Return new revision-id."""
437
 
    s = '%s-%s-' % (user_email(branch), compact_date(when))
438
 
    s += hexlify(rand_bytes(8))
439
 
    return s
440
 
 
441
 
 
442
 
 
443
 
    
444
 
def merge_ancestry_lines(rev_id, ancestries):
445
 
    """Return merged ancestry lines.
446
 
 
447
 
    rev_id -- id of the new revision
448
 
    
449
 
    ancestries -- a sequence of ancestries for parent revisions,
450
 
        as newline-terminated line lists.
451
 
    """
452
 
    if len(ancestries) == 0:
453
 
        return [rev_id + '\n']
454
 
    seen = set(ancestries[0])
455
 
    ancs = ancestries[0][:]    
456
 
    for parent_ancestry in ancestries[1:]:
457
 
        for line in parent_ancestry:
458
 
            assert line[-1] == '\n'
459
 
            if line not in seen:
460
 
                ancs.append(line)
461
 
                seen.add(line)
462
 
    r = rev_id + '\n'
463
 
    assert r not in seen
464
 
    ancs.append(r)
465
 
    return ancs
 
949
        # For carried over entries we don't care about the fs hash - the repo
 
950
        # isn't generating a sha, so we're not saving computation time.
 
951
        _, _, fs_hash = self.builder.record_entry_contents(
 
952
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
953
        if report_changes:
 
954
            self._report_change(ie, path)
 
955
        if fs_hash:
 
956
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
957
        return ie
 
958
 
 
959
    def _report_change(self, ie, path):
 
960
        """Report a change to the user.
 
961
 
 
962
        The change that has occurred is described relative to the basis
 
963
        inventory.
 
964
        """
 
965
        if (self.basis_inv.has_id(ie.file_id)):
 
966
            basis_ie = self.basis_inv[ie.file_id]
 
967
        else:
 
968
            basis_ie = None
 
969
        change = ie.describe_change(basis_ie, ie)
 
970
        if change in (InventoryEntry.RENAMED,
 
971
            InventoryEntry.MODIFIED_AND_RENAMED):
 
972
            old_path = self.basis_inv.id2path(ie.file_id)
 
973
            self.reporter.renamed(change, old_path, path)
 
974
            self._next_progress_entry()
 
975
        else:
 
976
            if change == gettext('unchanged'):
 
977
                return
 
978
            self.reporter.snapshot_change(change, path)
 
979
            self._next_progress_entry()
 
980
 
 
981
    def _set_progress_stage(self, name, counter=False):
 
982
        """Set the progress stage and emit an update to the progress bar."""
 
983
        self.pb_stage_name = name
 
984
        self.pb_stage_count += 1
 
985
        if counter:
 
986
            self.pb_entries_count = 0
 
987
        else:
 
988
            self.pb_entries_count = None
 
989
        self._emit_progress()
 
990
 
 
991
    def _next_progress_entry(self):
 
992
        """Emit an update to the progress bar and increment the entry count."""
 
993
        self.pb_entries_count += 1
 
994
        self._emit_progress()
 
995
 
 
996
    def _emit_progress(self):
 
997
        if self.pb_entries_count is not None:
 
998
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
 
999
                self.pb_entries_count)
 
1000
        else:
 
1001
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
1002
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
1003
 
 
1004
    def _set_specific_file_ids(self):
 
1005
        """populate self.specific_file_ids if we will use it."""
 
1006
        if not self.use_record_iter_changes:
 
1007
            # If provided, ensure the specified files are versioned
 
1008
            if self.specific_files is not None:
 
1009
                # Note: This routine is being called because it raises
 
1010
                # PathNotVersionedError as a side effect of finding the IDs. We
 
1011
                # later use the ids we found as input to the working tree
 
1012
                # inventory iterator, so we only consider those ids rather than
 
1013
                # examining the whole tree again.
 
1014
                # XXX: Dont we have filter_unversioned to do this more
 
1015
                # cheaply?
 
1016
                self.specific_file_ids = tree.find_ids_across_trees(
 
1017
                    self.specific_files, [self.basis_tree, self.work_tree])
 
1018
            else:
 
1019
                self.specific_file_ids = None