/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

Late bind to PatienceSequenceMatcher to allow plugin to override.

Show diffs side-by-side

added added

removed removed

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