← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Patch Queue Manager
  • Date: 2014-02-12 18:22:22 UTC
  • mfrom: (6589.2.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20140212182222-beouo25gaf1cny76
(vila) The XDG Base Directory Specification uses the XDG_CACHE_HOME,
 not XDG_CACHE_DIR. (Andrew Starr-Bochicchio)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
 
# Copyright (C) 2005, 2006 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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
17
18
 
18
19
# The newly committed revision is going to have a shape corresponding
19
 
# 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
20
21
# working tree and that were in the predecessor are reported as
21
22
# removed --- this can include files that were either removed from the
22
23
# inventory or deleted in the working tree.  If they were only
25
26
# We then consider the remaining entries, which will be in the new
26
27
# version.  Directory entries are simply copied across.  File entries
27
28
# must be checked to see if a new version of the file should be
28
 
# recorded.  For each parent revision inventory, we check to see what
 
29
# recorded.  For each parent revision tree, we check to see what
29
30
# version of the file was present.  If the file was present in at
30
31
# least one tree, and if it was the same version in all the trees,
31
32
# then we can just refer to that version.  Otherwise, a new version
49
50
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
51
# the rest of the code; add a deprecation of the old name.
51
52
 
52
 
import os
53
 
import re
54
 
import sys
55
 
import time
56
 
 
57
 
from cStringIO import StringIO
58
 
 
59
53
from bzrlib import (
 
54
    debug,
60
55
    errors,
61
 
    inventory,
 
56
    trace,
62
57
    tree,
 
58
    ui,
63
59
    )
64
60
from bzrlib.branch import Branch
 
61
from bzrlib.cleanup import OperationWithCleanups
65
62
import bzrlib.config
66
63
from bzrlib.errors import (BzrError, PointlessCommit,
67
64
                           ConflictsInTree,
68
65
                           StrictCommitFailed
69
66
                           )
70
 
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
71
 
                            is_inside_or_parent_of_any,
72
 
                            quotefn, sha_file, split_lines)
73
 
from bzrlib.testament import Testament
74
 
from bzrlib.trace import mutter, note, warning
75
 
from bzrlib.xml5 import serializer_v5
76
 
from bzrlib.inventory import Inventory, InventoryEntry
 
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
77
74
from bzrlib import symbol_versioning
78
 
from bzrlib.symbol_versioning import (deprecated_passed,
79
 
        deprecated_function,
80
 
        DEPRECATED_PARAMETER)
81
 
from bzrlib.workingtree import WorkingTree
82
 
import bzrlib.ui
83
 
 
 
75
from bzrlib.urlutils import unescape_for_display
 
76
from bzrlib.i18n import gettext
84
77
 
85
78
class NullCommitReporter(object):
86
79
    """I report on progress of a commit."""
87
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
88
    def snapshot_change(self, change, path):
89
89
        pass
90
90
 
91
91
    def completed(self, revno, rev_id):
92
92
        pass
93
93
 
94
 
    def deleted(self, file_id):
95
 
        pass
96
 
 
97
 
    def escaped(self, escape_count, message):
 
94
    def deleted(self, path):
98
95
        pass
99
96
 
100
97
    def missing(self, path):
103
100
    def renamed(self, change, old_path, new_path):
104
101
        pass
105
102
 
 
103
    def is_verbose(self):
 
104
        return False
 
105
 
106
106
 
107
107
class ReportCommitToLog(NullCommitReporter):
108
108
 
109
 
    # this may be more useful if 'note' was replaced by an overridable
110
 
    # method on self, which would allow more trivial subclassing.
111
 
    # alternative, a callable could be passed in, allowing really trivial
112
 
    # reuse for some uis. RBC 20060511
 
109
    def _note(self, format, *args):
 
110
        """Output a message.
 
111
 
 
112
        Subclasses may choose to override this method.
 
113
        """
 
114
        note(format, *args)
113
115
 
114
116
    def snapshot_change(self, change, path):
115
 
        if change == 'unchanged':
116
 
            return
117
 
        if change == 'added' and path == '':
118
 
            return
119
 
        note("%s %s", 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)
120
132
 
121
133
    def completed(self, revno, rev_id):
122
 
        note('Committed revision %d.', revno)
123
 
    
124
 
    def deleted(self, file_id):
125
 
        note('deleted %s', file_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)
126
141
 
127
 
    def escaped(self, escape_count, message):
128
 
        note("replaced %d control characters in message", escape_count)
 
142
    def deleted(self, path):
 
143
        self._note(gettext('deleted %s'), path)
129
144
 
130
145
    def missing(self, path):
131
 
        note('missing %s', path)
 
146
        self._note(gettext('missing %s'), path)
132
147
 
133
148
    def renamed(self, change, old_path, new_path):
134
 
        note('%s %s => %s', 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
135
153
 
136
154
 
137
155
class Commit(object):
148
166
    """
149
167
    def __init__(self,
150
168
                 reporter=None,
151
 
                 config=None):
152
 
        if reporter is not None:
153
 
            self.reporter = reporter
154
 
        else:
155
 
            self.reporter = NullCommitReporter()
156
 
        if config is not None:
157
 
            self.config = config
158
 
        else:
159
 
            self.config = None
160
 
        
 
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
 
161
214
    def commit(self,
162
 
               branch=DEPRECATED_PARAMETER, message=None,
 
215
               message=None,
163
216
               timestamp=None,
164
217
               timezone=None,
165
218
               committer=None,
173
226
               local=False,
174
227
               reporter=None,
175
228
               config=None,
176
 
               message_callback=None):
 
229
               message_callback=None,
 
230
               recursive='down',
 
231
               exclude=None,
 
232
               possible_master_transports=None,
 
233
               lossy=False):
177
234
        """Commit working copy as a new revision.
178
235
 
179
 
        branch -- the deprecated branch to commit to. New callers should pass in 
180
 
                  working_tree instead
181
 
 
182
 
        message -- the commit message (it or message_callback is required)
183
 
 
184
 
        timestamp -- if not None, seconds-since-epoch for a
185
 
             postdated/predated commit.
186
 
 
187
 
        specific_files -- If true, commit only those files.
188
 
 
189
 
        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.
190
246
            Useful for test or import commands that need to tightly
191
247
            control what revisions are assigned.  If you duplicate
192
248
            a revision id that exists elsewhere it is your own fault.
193
249
            If null (default), a time/random revision id is generated.
194
250
 
195
 
        allow_pointless -- If true (default), commit even if nothing
 
251
        :param allow_pointless: If true (default), commit even if nothing
196
252
            has changed and no merges are recorded.
197
253
 
198
 
        strict -- If true, don't allow a commit if the working tree
 
254
        :param strict: If true, don't allow a commit if the working tree
199
255
            contains unknown files.
200
256
 
201
 
        revprops -- Properties for new revision
 
257
        :param revprops: Properties for new revision
202
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.
203
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):
204
296
        mutter('preparing to commit')
205
297
 
206
 
        if deprecated_passed(branch):
207
 
            symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
208
 
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
209
 
                 DeprecationWarning, stacklevel=2)
210
 
            self.branch = branch
211
 
            self.work_tree = self.branch.bzrdir.open_workingtree()
212
 
        elif working_tree is None:
213
 
            raise BzrError("One of branch and working_tree must be passed into commit().")
 
298
        if working_tree is None:
 
299
            raise BzrError("working_tree must be passed into commit().")
214
300
        else:
215
301
            self.work_tree = working_tree
216
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()
217
306
        if message_callback is None:
218
307
            if message is not None:
219
308
                if isinstance(message, str):
220
 
                    message = message.decode(bzrlib.user_encoding)
 
309
                    message = message.decode(get_user_encoding())
221
310
                message_callback = lambda x: message
222
311
            else:
223
312
                raise BzrError("The message or message_callback keyword"
224
313
                               " parameter is required for commit().")
225
314
 
226
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 = []
227
322
        self.local = local
228
323
        self.master_branch = None
229
 
        self.master_locked = False
 
324
        self.recursive = recursive
230
325
        self.rev_id = None
231
 
        self.specific_files = specific_files
 
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
 
232
334
        self.allow_pointless = allow_pointless
233
 
 
234
 
        if reporter is None and self.reporter is None:
235
 
            self.reporter = NullCommitReporter()
236
 
        elif reporter is not None:
237
 
            self.reporter = reporter
 
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
238
341
 
239
342
        self.work_tree.lock_write()
240
 
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
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()
241
356
        self.basis_tree = self.work_tree.basis_tree()
242
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
 
243
421
        try:
244
 
            # Cannot commit with conflicts present.
245
 
            if len(self.work_tree.conflicts())>0:
246
 
                raise ConflictsInTree
247
 
 
248
 
            # setup the bound branch variables as needed.
249
 
            self._check_bound_branch()
250
 
 
251
 
            # check for out of date working trees
252
 
            try:
253
 
                first_tree_parent = self.work_tree.get_parent_ids()[0]
254
 
            except IndexError:
255
 
                # if there are no parents, treat our parent as 'None'
256
 
                # this is so that we still consier the master branch
257
 
                # - in a checkout scenario the tree may have no
258
 
                # parents but the branch may do.
259
 
                first_tree_parent = bzrlib.revision.NULL_REVISION
260
 
            old_revno, master_last = self.master_branch.last_revision_info()
261
 
            if master_last != first_tree_parent:
262
 
                if master_last != bzrlib.revision.NULL_REVISION:
263
 
                    raise errors.OutOfDateTree(self.work_tree)
264
 
            if self.branch.repository.has_revision(first_tree_parent):
265
 
                new_revno = old_revno + 1
 
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
266
426
            else:
267
 
                # ghost parents never appear in revision history.
268
 
                new_revno = 1
269
 
            if strict:
270
 
                # raise an exception as soon as we find a single unknown.
271
 
                for unknown in self.work_tree.unknowns():
272
 
                    raise StrictCommitFailed()
273
 
                   
274
 
            if self.config is None:
275
 
                self.config = self.branch.get_config()
276
 
 
277
 
            self.work_inv = self.work_tree.inventory
278
 
            self.basis_inv = self.basis_tree.inventory
279
 
            if specific_files is not None:
280
 
                # Ensure specified files are versioned
281
 
                # (We don't actually need the ids here)
282
 
                tree.find_ids_across_trees(specific_files, 
283
 
                                           [self.basis_tree, self.work_tree])
284
 
            # one to finish, one for rev and inventory, and one for each
285
 
            # inventory entry, and the same for the new inventory.
286
 
            # note that this estimate is too long when we do a partial tree
287
 
            # commit which excludes some new files from being considered.
288
 
            # The estimate is corrected when we populate the new inv.
289
 
            self.pb_total = len(self.work_inv) + 5
290
 
            self.pb_count = 0
291
 
 
292
 
            self._gather_parents()
293
 
            if len(self.parents) > 1 and self.specific_files:
294
 
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
295
 
                        self.specific_files)
296
 
            
297
 
            self.builder = self.branch.get_commit_builder(self.parents, 
298
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
299
 
            
300
 
            self._remove_deleted()
301
 
            self._populate_new_inv()
302
 
            self._report_deletes()
303
 
 
 
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()
304
433
            self._check_pointless()
305
434
 
306
 
            self._emit_progress_update()
307
 
            # TODO: Now the new inventory is known, check for conflicts and
308
 
            # prompt the user for a commit message.
 
435
            # TODO: Now the new inventory is known, check for conflicts.
309
436
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
310
437
            # weave lines, because nothing should be recorded until it is known
311
438
            # that commit will succeed.
 
439
            self._set_progress_stage("Saving data locally")
312
440
            self.builder.finish_inventory()
313
 
            self._emit_progress_update()
 
441
 
 
442
            # Prompt the user for a commit message if none provided
314
443
            message = message_callback(self)
315
 
            assert isinstance(message, unicode), type(message)
316
444
            self.message = message
317
 
            self._escape_commit_message()
318
445
 
 
446
            # Add revision data to the local branch
319
447
            self.rev_id = self.builder.commit(self.message)
320
 
            self._emit_progress_update()
321
 
            # revision data is in the local branch now.
322
 
            
323
 
            # upload revision data to the master.
 
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.
324
483
            # this will propagate merged revisions too if needed.
325
484
            if self.bound_branch:
326
 
                self.master_branch.repository.fetch(self.branch.repository,
327
 
                                                    revision_id=self.rev_id)
328
 
                # now the master has the revision data
329
 
                # 'commit' to the master first so a timeout here causes the local
330
 
                # branch to be out of date
331
 
                self.master_branch.set_last_revision_info(new_revno,
332
 
                                                          self.rev_id)
 
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)
333
492
 
334
493
            # and now do the commit locally.
335
494
            self.branch.set_last_revision_info(new_revno, self.rev_id)
336
 
 
337
 
            rev_tree = self.builder.revision_tree()
338
 
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
339
 
            # now the work tree is up to date with the branch
340
 
            
341
 
            self.reporter.completed(new_revno, self.rev_id)
342
 
            # old style commit hooks - should be deprecated ? (obsoleted in
343
 
            # 0.15)
344
 
            if self.config.post_commit() is not None:
345
 
                hooks = self.config.post_commit().split(' ')
346
 
                # this would be nicer with twisted.python.reflect.namedAny
347
 
                for hook in hooks:
348
 
                    result = eval(hook + '(branch, rev_id)',
349
 
                                  {'branch':self.branch,
350
 
                                   'bzrlib':bzrlib,
351
 
                                   'rev_id':self.rev_id})
352
 
            # new style commit hooks:
353
 
            if not self.bound_branch:
354
 
                hook_master = self.branch
355
 
                hook_local = None
356
 
            else:
357
 
                hook_master = self.master_branch
358
 
                hook_local = self.branch
359
 
            # With bound branches, when the master is behind the local branch,
360
 
            # the 'old_revno' and old_revid values here are incorrect.
361
 
            # XXX: FIXME ^. RBC 20060206
362
 
            if self.parents:
363
 
                old_revid = self.parents[0]
364
 
            else:
365
 
                old_revid = bzrlib.revision.NULL_REVISION
366
 
            for hook in Branch.hooks['post_commit']:
367
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
368
 
                    self.rev_id)
369
 
            self._emit_progress_update()
370
 
        finally:
371
 
            self._cleanup()
372
 
        return self.rev_id
373
 
 
374
 
    def _any_real_changes(self):
375
 
        """Are there real changes between new_inventory and basis?
376
 
 
377
 
        For trees without rich roots, inv.root.revision changes every commit.
378
 
        But if that is the only change, we want to treat it as though there
379
 
        are *no* changes.
380
 
        """
381
 
        new_entries = self.builder.new_inventory.iter_entries()
382
 
        basis_entries = self.basis_inv.iter_entries()
383
 
        new_path, new_root_ie = new_entries.next()
384
 
        basis_path, basis_root_ie = basis_entries.next()
385
 
 
386
 
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
387
 
        def ie_equal_no_revision(this, other):
388
 
            return ((this.file_id == other.file_id)
389
 
                    and (this.name == other.name)
390
 
                    and (this.symlink_target == other.symlink_target)
391
 
                    and (this.text_sha1 == other.text_sha1)
392
 
                    and (this.text_size == other.text_size)
393
 
                    and (this.text_id == other.text_id)
394
 
                    and (this.parent_id == other.parent_id)
395
 
                    and (this.kind == other.kind)
396
 
                    and (this.executable == other.executable)
397
 
                    )
398
 
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
399
 
            return True
400
 
 
401
 
        for new_ie, basis_ie in zip(new_entries, basis_entries):
402
 
            if new_ie != basis_ie:
403
 
                return True
404
 
 
405
 
        # No actual changes present
406
 
        return False
 
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()
407
519
 
408
520
    def _check_pointless(self):
409
521
        if self.allow_pointless:
411
523
        # A merge with no effect on files
412
524
        if len(self.parents) > 1:
413
525
            return
414
 
        # work around the fact that a newly-initted tree does differ from its
415
 
        # basis
416
 
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
417
 
            raise PointlessCommit()
418
 
        # Shortcut, if the number of entries changes, then we obviously have
419
 
        # a change
420
 
        if len(self.builder.new_inventory) != len(self.basis_inv):
421
 
            return
422
 
        # If length == 1, then we only have the root entry. Which means
423
 
        # that there is no real difference (only the root could be different)
424
 
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
 
526
        if self.builder.any_changes():
425
527
            return
426
528
        raise PointlessCommit()
427
529
 
428
 
    def _check_bound_branch(self):
 
530
    def _check_bound_branch(self, operation, possible_master_transports=None):
429
531
        """Check to see if the local branch is bound.
430
532
 
431
533
        If it is bound, then most of the commit will actually be
436
538
            raise errors.LocalRequiresBoundBranch()
437
539
 
438
540
        if not self.local:
439
 
            self.master_branch = self.branch.get_master_branch()
 
541
            self.master_branch = self.branch.get_master_branch(
 
542
                possible_master_transports)
440
543
 
441
544
        if not self.master_branch:
442
545
            # make this branch the reference branch for out of date checks.
453
556
        #       commits to the remote branch if they would fit.
454
557
        #       But for now, just require remote to be identical
455
558
        #       to local.
456
 
        
 
559
 
457
560
        # Make sure the local branch is identical to the master
458
561
        master_info = self.master_branch.last_revision_info()
459
562
        local_info = self.branch.last_revision_info()
465
568
        # so grab the lock
466
569
        self.bound_branch = self.branch
467
570
        self.master_branch.lock_write()
468
 
        self.master_locked = True
469
 
 
470
 
    def _cleanup(self):
471
 
        """Cleanup any open locks, progress bars etc."""
472
 
        cleanups = [self._cleanup_bound_branch,
473
 
                    self.basis_tree.unlock,
474
 
                    self.work_tree.unlock,
475
 
                    self.pb.finished]
476
 
        found_exception = None
477
 
        for cleanup in cleanups:
478
 
            try:
479
 
                cleanup()
480
 
            # we want every cleanup to run no matter what.
481
 
            # so we have a catchall here, but we will raise the
482
 
            # last encountered exception up the stack: and
483
 
            # typically this will be useful enough.
484
 
            except Exception, e:
485
 
                found_exception = e
486
 
        if found_exception is not None: 
487
 
            # don't do a plan raise, because the last exception may have been
488
 
            # trashed, e is our sure-to-work exception even though it loses the
489
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
490
 
            # exc_info and if its the same one do a plain raise otherwise 
491
 
            # 'raise e' as we do now.
492
 
            raise e
493
 
 
494
 
    def _cleanup_bound_branch(self):
495
 
        """Executed at the end of a try/finally to cleanup a bound branch.
496
 
 
497
 
        If the branch wasn't bound, this is a no-op.
498
 
        If it was, it resents self.branch to the local branch, instead
499
 
        of being the master.
 
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
500
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:
501
626
        if not self.bound_branch:
502
 
            return
503
 
        if self.master_locked:
504
 
            self.master_branch.unlock()
505
 
 
506
 
    def _escape_commit_message(self):
507
 
        """Replace xml-incompatible control characters."""
508
 
        # FIXME: RBC 20060419 this should be done by the revision
509
 
        # serialiser not by commit. Then we can also add an unescaper
510
 
        # in the deserializer and start roundtripping revision messages
511
 
        # precisely. See repository_implementations/test_repository.py
512
 
        
513
 
        # Python strings can include characters that can't be
514
 
        # represented in well-formed XML; escape characters that
515
 
        # aren't listed in the XML specification
516
 
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
517
 
        self.message, escape_count = re.subn(
518
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
519
 
            lambda match: match.group(0).encode('unicode_escape'),
520
 
            self.message)
521
 
        if escape_count:
522
 
            self.reporter.escaped(escape_count, self.message)
 
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)
523
663
 
524
664
    def _gather_parents(self):
525
665
        """Record the parents of a merge for merge detection."""
526
 
        # TODO: Make sure that this list doesn't contain duplicate 
 
666
        # TODO: Make sure that this list doesn't contain duplicate
527
667
        # entries and the order is preserved when doing this.
528
 
        self.parents = self.work_tree.get_parent_ids()
 
668
        if self.use_record_iter_changes:
 
669
            return
 
670
        self.basis_inv = self.basis_tree.root_inventory
529
671
        self.parent_invs = [self.basis_inv]
530
672
        for revision in self.parents[1:]:
531
673
            if self.branch.repository.has_revision(revision):
535
677
            else:
536
678
                mutter('commit parent ghost revision {%s}', revision)
537
679
 
538
 
    def _remove_deleted(self):
539
 
        """Remove deleted files from the working inventories.
540
 
 
541
 
        This is done prior to taking the working inventory as the
542
 
        basis for the new committed inventory.
543
 
 
544
 
        This returns true if any files
545
 
        *that existed in the basis inventory* were deleted.
546
 
        Files that were added and deleted
547
 
        in the working copy don't matter.
548
 
        """
549
 
        specific = self.specific_files
 
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()
550
713
        deleted_ids = []
551
 
        deleted_paths = set()
552
 
        for path, ie in self.work_inv.iter_entries():
553
 
            if is_inside_any(deleted_paths, path):
554
 
                # The tree will delete the required ids recursively.
555
 
                continue
556
 
            if specific and not is_inside_any(specific, path):
557
 
                continue
558
 
            if not self.work_tree.has_filename(path):
559
 
                deleted_paths.add(path)
560
 
                self.reporter.missing(path)
561
 
                deleted_ids.append(ie.file_id)
562
 
        self.work_tree.unversion(deleted_ids)
563
 
 
564
 
    def _populate_new_inv(self):
565
 
        """Build revision inventory.
566
 
 
567
 
        This creates a new empty inventory. Depending on
568
 
        which files are selected for commit, and what is present in the
569
 
        current tree, the new inventory is populated. inventory entries 
570
 
        which are candidates for modification have their revision set to
571
 
        None; inventory entries that are carried over untouched have their
572
 
        revision set to their prior value.
573
 
        """
 
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
        #
574
823
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
575
824
        # results to create a new inventory at the same time, which results
576
825
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
577
826
        # ADHB 11-07-2006
578
 
        mutter("Selecting files for commit with filter %s", self.specific_files)
579
 
        assert self.work_inv.root is not None
580
 
        entries = self.work_inv.iter_entries()
581
 
        if not self.builder.record_root_entry:
582
 
            symbol_versioning.warn('CommitBuilders should support recording'
583
 
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
584
 
                stacklevel=1)
585
 
            self.builder.new_inventory.add(self.basis_inv.root.copy())
586
 
            entries.next()
587
 
            self._emit_progress_update()
588
 
        for path, new_ie in entries:
589
 
            self._emit_progress_update()
590
 
            file_id = new_ie.file_id
591
 
            try:
592
 
                kind = self.work_tree.kind(file_id)
593
 
                if kind != new_ie.kind:
594
 
                    new_ie = inventory.make_entry(kind, new_ie.name,
595
 
                                                  new_ie.parent_id, file_id)
596
 
            except errors.NoSuchFile:
597
 
                pass
598
 
            # mutter('check %s {%s}', path, file_id)
599
 
            if (not self.specific_files or 
600
 
                is_inside_or_parent_of_any(self.specific_files, path)):
601
 
                    # mutter('%s selected for commit', path)
602
 
                    ie = new_ie.copy()
603
 
                    ie.revision = None
604
 
            else:
605
 
                # mutter('%s not selected for commit', path)
606
 
                if self.basis_inv.has_id(file_id):
607
 
                    ie = self.basis_inv[file_id].copy()
608
 
                else:
609
 
                    # this entry is new and not being committed
610
 
                    continue
611
 
            self.builder.record_entry_contents(ie, self.parent_invs, 
612
 
                path, self.work_tree)
613
 
            # describe the nature of the change that has occurred relative to
614
 
            # the basis inventory.
615
 
            if (self.basis_inv.has_id(ie.file_id)):
616
 
                basis_ie = self.basis_inv[ie.file_id]
617
 
            else:
618
 
                basis_ie = None
619
 
            change = ie.describe_change(basis_ie, ie)
620
 
            if change in (InventoryEntry.RENAMED, 
621
 
                InventoryEntry.MODIFIED_AND_RENAMED):
622
 
                old_path = self.basis_inv.id2path(ie.file_id)
623
 
                self.reporter.renamed(change, old_path, path)
624
 
            else:
625
 
                self.reporter.snapshot_change(change, path)
626
 
 
627
 
        if not self.specific_files:
628
 
            return
629
 
 
630
 
        # ignore removals that don't match filespec
631
 
        for path, new_ie in self.basis_inv.iter_entries():
632
 
            if new_ie.file_id in self.work_inv:
633
 
                continue
634
 
            if is_inside_any(self.specific_files, path):
635
 
                continue
636
 
            ie = new_ie.copy()
 
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
 
859
                else:
 
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.
 
867
                continue
 
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)
 
897
                else:
 
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()
637
948
            ie.revision = None
638
 
            self.builder.record_entry_contents(ie, self.parent_invs, path,
639
 
                                               self.basis_tree)
640
 
 
641
 
    def _emit_progress_update(self):
642
 
        """Emit an update to the progress bar."""
643
 
        self.pb.update("Committing", self.pb_count, self.pb_total)
644
 
        self.pb_count += 1
645
 
 
646
 
    def _report_deletes(self):
647
 
        for path, ie in self.basis_inv.iter_entries():
648
 
            if ie.file_id not in self.builder.new_inventory:
649
 
                self.reporter.deleted(path)
650
 
 
651
 
 
 
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