/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-01-15 06:15:54 UTC
  • mfrom: (3172.4.4 more-find-ghosts)
  • Revision ID: pqm@pqm.ubuntu.com-20080115061554-qyfxjo4fxlsjobar
(robertc) Stop fetching ghosts over the smart server pulls by
        default. (Robert Collins)

Show diffs side-by-side

added added

removed removed

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