~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

Nearly complete .bzr/checkout splitout.

Show diffs side-by-side

added added

removed removed

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