~bzr-pqm/bzr/bzr.dev

485 by Martin Pool
- move commit code into its own module
1
# Copyright (C) 2005 Canonical Ltd
1248 by Martin Pool
- new weave based cleanup [broken]
2
#
485 by Martin Pool
- move commit code into its own module
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
1248 by Martin Pool
- new weave based cleanup [broken]
7
#
485 by Martin Pool
- move commit code into its own module
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
1248 by Martin Pool
- new weave based cleanup [broken]
12
#
485 by Martin Pool
- move commit code into its own module
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
1248 by Martin Pool
- new weave based cleanup [broken]
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
# The newly committed revision is going to have a shape corresponding
29
# to that of the working inventory.  Files that are not in the
30
# working tree and that were in the predecessor are reported as
31
# removed --- this can include files that were either removed from the
32
# inventory or deleted in the working tree.  If they were only
33
# deleted from disk, they are removed from the working inventory.
34
35
# We then consider the remaining entries, which will be in the new
36
# version.  Directory entries are simply copied across.  File entries
37
# 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
39
# version of the file was present.  If the file was present in at
40
# least one tree, and if it was the same version in all the trees,
41
# then we can just refer to that version.  Otherwise, a new version
42
# representing the merger of the file versions must be added.
43
44
# TODO: Update hashcache before and after - or does the WorkingTree
45
# look after that?
1245 by Martin Pool
doc
46
1339 by Martin Pool
- doc
47
# TODO: Rather than mashing together the ancestry and storing it back,
48
# perhaps the weave should have single method which does it all in one
49
# go, avoiding a lot of redundant work.
1335 by Martin Pool
doc
50
1341 by Martin Pool
- doc
51
# TODO: Perhaps give a warning if one of the revisions marked as
52
# merged is already in the ancestry, and then don't record it as a
53
# distinct parent.
54
1343 by Martin Pool
- fix up test for merge of trees
55
# TODO: If the file is newly merged but unchanged from the version it
56
# merges from, then it should still be reported as newly added
57
# relative to the basis revision.
58
1185.16.66 by mbp at sourcefrog
- todo
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
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
65
1189 by Martin Pool
- BROKEN: partial support for commit into weave
66
import os
1390 by Robert Collins
pair programming worx... merge integration and weave
67
import re
1189 by Martin Pool
- BROKEN: partial support for commit into weave
68
import sys
1188 by Martin Pool
- clean up imports in commit code
69
import time
1248 by Martin Pool
- new weave based cleanup [broken]
70
import pdb
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
71
1188 by Martin Pool
- clean up imports in commit code
72
from binascii import hexlify
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
73
from cStringIO import StringIO
1188 by Martin Pool
- clean up imports in commit code
74
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
75
from bzrlib.atomicfile import AtomicFile
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
76
from bzrlib.osutils import (local_time_offset,
77
                            rand_bytes, compact_date,
1188 by Martin Pool
- clean up imports in commit code
78
                            kind_marker, is_inside_any, quotefn,
1570.1.2 by Robert Collins
Import bzrtools' 'fix' command as 'bzr reconcile.'
79
                            sha_file, isdir, isfile,
1248 by Martin Pool
- new weave based cleanup [broken]
80
                            split_lines)
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
81
import bzrlib.config
1508.1.22 by Robert Collins
implement out of date working tree checks in commit.
82
import bzrlib.errors as errors
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
83
from bzrlib.errors import (BzrError, PointlessCommit,
84
                           HistoryMissing,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
85
                           ConflictsInTree,
86
                           StrictCommitFailed
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
87
                           )
1311 by Martin Pool
- remove RevisionReference; just hold parent ids directly
88
from bzrlib.revision import Revision
1442.1.62 by Robert Collins
Allow creation of testaments from uncommitted data, and use that to get signatures before committing revisions.
89
from bzrlib.testament import Testament
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
90
from bzrlib.trace import mutter, note, warning
1189 by Martin Pool
- BROKEN: partial support for commit into weave
91
from bzrlib.xml5 import serializer_v5
1416 by Robert Collins
when committing a specific file, include all its parents
92
from bzrlib.inventory import Inventory, ROOT_ID
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
93
from bzrlib.symbol_versioning import *
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
94
from bzrlib.workingtree import WorkingTree
1189 by Martin Pool
- BROKEN: partial support for commit into weave
95
96
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
97
@deprecated_function(zero_seven)
1205 by Martin Pool
- add bzrlib.commit.commit compatability interface
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
    """
1276 by Martin Pool
- make Branch.commit accept (and ignore) verbose argument
105
    ## XXX: Remove this in favor of Branch.commit?
1205 by Martin Pool
- add bzrlib.commit.commit compatability interface
106
    Commit().commit(*args, **kwargs)
107
108
1189 by Martin Pool
- BROKEN: partial support for commit into weave
109
class NullCommitReporter(object):
110
    """I report on progress of a commit."""
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
111
112
    def snapshot_change(self, change, path):
113
        pass
114
115
    def completed(self, revno, rev_id):
116
        pass
117
118
    def deleted(self, file_id):
119
        pass
120
121
    def escaped(self, escape_count, message):
122
        pass
123
124
    def missing(self, path):
125
        pass
1189 by Martin Pool
- BROKEN: partial support for commit into weave
126
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
127
1189 by Martin Pool
- BROKEN: partial support for commit into weave
128
class ReportCommitToLog(NullCommitReporter):
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
129
130
    def snapshot_change(self, change, path):
1616.1.4 by Martin Pool
Verbose commit shouldn't talk about every unchanged file.
131
        if change == 'unchanged':
132
            return
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
133
        note("%s %s", change, path)
134
135
    def completed(self, revno, rev_id):
1607.1.5 by Robert Collins
Make commit verbose mode work!.
136
        note('Committed revision %d.', revno)
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
137
    
138
    def deleted(self, file_id):
139
        note('deleted %s', file_id)
140
141
    def escaped(self, escape_count, message):
142
        note("replaced %d control characters in message", escape_count)
143
144
    def missing(self, path):
145
        note('missing %s', path)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
146
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
147
1189 by Martin Pool
- BROKEN: partial support for commit into weave
148
class Commit(object):
149
    """Task of committing a new revision.
150
151
    This is a MethodObject: it accumulates state as the commit is
152
    prepared, and then it is discarded.  It doesn't represent
153
    historical revisions, just the act of recording a new one.
154
155
            missing_ids
156
            Modified to hold a list of files that have been deleted from
157
            the working directory; these should be removed from the
158
            working inventory.
485 by Martin Pool
- move commit code into its own module
159
    """
1189 by Martin Pool
- BROKEN: partial support for commit into weave
160
    def __init__(self,
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
161
                 reporter=None,
162
                 config=None):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
163
        if reporter is not None:
164
            self.reporter = reporter
165
        else:
166
            self.reporter = NullCommitReporter()
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
167
        if config is not None:
168
            self.config = config
169
        else:
170
            self.config = None
1189 by Martin Pool
- BROKEN: partial support for commit into weave
171
        
172
    def commit(self,
1534.4.32 by Robert Collins
Rename deprecated_nonce to DEPRECATED_PARAMETER
173
               branch=DEPRECATED_PARAMETER, message=None,
1189 by Martin Pool
- BROKEN: partial support for commit into weave
174
               timestamp=None,
175
               timezone=None,
176
               committer=None,
177
               specific_files=None,
178
               rev_id=None,
1276 by Martin Pool
- make Branch.commit accept (and ignore) verbose argument
179
               allow_pointless=True,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
180
               strict=False,
1185.16.35 by Martin Pool
- stub for revision properties
181
               verbose=False,
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
182
               revprops=None,
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
183
               working_tree=None,
1607.1.5 by Robert Collins
Make commit verbose mode work!.
184
               local=False,
185
               reporter=None,
186
               config=None):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
187
        """Commit working copy as a new revision.
188
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
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
1189 by Martin Pool
- BROKEN: partial support for commit into weave
194
        timestamp -- if not None, seconds-since-epoch for a
195
             postdated/predated commit.
196
1253 by Martin Pool
- test that pointless commits are trapped
197
        specific_files -- If true, commit only those files.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
198
1253 by Martin Pool
- test that pointless commits are trapped
199
        rev_id -- If set, use this as the new revision id.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
200
            Useful for test or import commands that need to tightly
201
            control what revisions are assigned.  If you duplicate
202
            a revision id that exists elsewhere it is your own fault.
203
            If null (default), a time/random revision id is generated.
1253 by Martin Pool
- test that pointless commits are trapped
204
205
        allow_pointless -- If true (default), commit even if nothing
206
            has changed and no merges are recorded.
1185.16.35 by Martin Pool
- stub for revision properties
207
1185.16.65 by mbp at sourcefrog
- new commit --strict option
208
        strict -- If true, don't allow a commit if the working tree
209
            contains unknown files.
210
1185.16.35 by Martin Pool
- stub for revision properties
211
        revprops -- Properties for new revision
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
212
        :param local: Perform a local only commit.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
213
        """
1285 by Martin Pool
- fix bug in committing files that are renamed but not modified
214
        mutter('preparing to commit')
1189 by Martin Pool
- BROKEN: partial support for commit into weave
215
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
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.",
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
219
                 DeprecationWarning, stacklevel=2)
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
220
            self.branch = branch
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
221
            self.work_tree = self.branch.bzrdir.open_workingtree()
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
222
        elif working_tree is None:
223
            raise BzrError("One of branch and working_tree must be passed into commit().")
224
        else:
225
            self.work_tree = working_tree
226
            self.branch = self.work_tree.branch
227
        if message is None:
228
            raise BzrError("The message keyword parameter is required for commit().")
229
1534.4.28 by Robert Collins
first cut at merge from integration.
230
        self.weave_store = self.branch.repository.weave_store
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
231
        self.bound_branch = None
1587.1.9 by Robert Collins
Local commits do no alter or access the master branch.
232
        self.local = local
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
233
        self.master_branch = None
1614.1.1 by Aaron Bentley
Fixed master locking in commit
234
        self.master_locked = False
1189 by Martin Pool
- BROKEN: partial support for commit into weave
235
        self.rev_id = rev_id
236
        self.specific_files = specific_files
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
237
        self.allow_pointless = allow_pointless
1593.1.1 by Robert Collins
Move responsibility for setting branch nickname in commits to the WorkingTree convenience function.
238
        self.revprops = {}
239
        if revprops is not None:
1185.35.15 by Aaron Bentley
Added branch nicks to revisions
240
            self.revprops.update(revprops)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
241
1607.1.5 by Robert Collins
Make commit verbose mode work!.
242
        if reporter is None and self.reporter is None:
243
            self.reporter = NullCommitReporter()
1607.1.8 by Robert Collins
Integrate latest bzr.dev.
244
        elif reporter is not None:
1607.1.5 by Robert Collins
Make commit verbose mode work!.
245
            self.reporter = reporter
246
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
247
        self.work_tree.lock_write()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
248
        try:
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
249
            # setup the bound branch variables as needed.
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
250
            self._check_bound_branch()
251
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
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.
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
255
            if self.work_tree.last_revision() != self.master_branch.last_revision():
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
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
                
268
            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
1189 by Martin Pool
- BROKEN: partial support for commit into weave
293
            self.work_inv = self.work_tree.inventory
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
294
            self.basis_tree = self.work_tree.basis_tree()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
295
            self.basis_inv = self.basis_tree.inventory
296
1223 by Martin Pool
- store inventories in weave
297
            self._gather_parents()
1344 by Martin Pool
- disallow selected-file commit of merges
298
            if len(self.parents) > 1 and self.specific_files:
299
                raise NotImplementedError('selected-file commit of merges is not supported yet')
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
300
            self._check_parents_present()
301
            
1251 by Martin Pool
- fix up commit in directory with some deleted files
302
            self._remove_deleted()
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
303
            self._populate_new_inv()
304
            self._store_snapshot()
1248 by Martin Pool
- new weave based cleanup [broken]
305
            self._report_deletes()
1245 by Martin Pool
doc
306
1248 by Martin Pool
- new weave based cleanup [broken]
307
            if not (self.allow_pointless
1279 by Martin Pool
- pointless commit of r1 no longer allowed
308
                    or len(self.parents) > 1
1249 by Martin Pool
- improvements to weave commit [broken]
309
                    or self.new_inv != self.basis_inv):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
310
                raise PointlessCommit()
311
1185.14.10 by Aaron Bentley
Commit aborts with conflicts in the tree.
312
            if len(list(self.work_tree.iter_conflicts()))>0:
313
                raise ConflictsInTree
314
1570.1.2 by Robert Collins
Import bzrtools' 'fix' command as 'bzr reconcile.'
315
            self.inv_sha1 = self.branch.repository.add_inventory(
316
                self.rev_id,
317
                self.new_inv,
318
                self.present_parents
319
                )
1189 by Martin Pool
- BROKEN: partial support for commit into weave
320
            self._make_revision()
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
321
            # revision data is in the local branch now.
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
322
            
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
323
            # upload revision data to the master.
324
            # this will propogate merged revisions too if needed.
325
            if self.bound_branch:
326
                self.master_branch.repository.fetch(self.branch.repository,
327
                                                    revision_id=self.rev_id)
328
                # now the master has the revision data
329
                # 'commit' to the master first so a timeout here causes the local
330
                # branch to be out of date
331
                self.master_branch.append_revision(self.rev_id)
332
333
            # and now do the commit locally.
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
334
            self.branch.append_revision(self.rev_id)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
335
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
336
            self.work_tree.set_pending_merges([])
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
337
            if len(self.parents):
338
                precursor = self.parents[0]
339
            else:
340
                precursor = None
341
            self.work_tree.set_last_revision(self.rev_id, precursor)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
342
            # now the work tree is up to date with the branch
343
            
1607.1.5 by Robert Collins
Make commit verbose mode work!.
344
            self.reporter.completed(self.branch.revno(), self.rev_id)
1472 by Robert Collins
post commit hook, first pass implementation
345
            if self.config.post_commit() is not None:
346
                hooks = self.config.post_commit().split(' ')
347
                # this would be nicer with twisted.python.reflect.namedAny
348
                for hook in hooks:
349
                    result = eval(hook + '(branch, rev_id)',
350
                                  {'branch':self.branch,
351
                                   'bzrlib':bzrlib,
352
                                   'rev_id':self.rev_id})
1189 by Martin Pool
- BROKEN: partial support for commit into weave
353
        finally:
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
354
            self._cleanup_bound_branch()
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
355
            self.work_tree.unlock()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
356
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
357
    def _check_bound_branch(self):
358
        """Check to see if the local branch is bound.
359
360
        If it is bound, then most of the commit will actually be
361
        done using the remote branch as the target branch.
362
        Only at the end will the local branch be updated.
363
        """
1587.1.9 by Robert Collins
Local commits do no alter or access the master branch.
364
        if self.local and not self.branch.get_bound_location():
365
            raise errors.LocalRequiresBoundBranch()
366
367
        if not self.local:
368
            self.master_branch = self.branch.get_master_branch()
369
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
370
        if not self.master_branch:
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
371
            # make this branch the reference branch for out of date checks.
372
            self.master_branch = self.branch
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
373
            return
374
375
        # If the master branch is bound, we must fail
376
        master_bound_location = self.master_branch.get_bound_location()
377
        if master_bound_location:
1505.1.27 by John Arbash Meinel
Adding tests against an sftp branch.
378
            raise errors.CommitToDoubleBoundBranch(self.branch,
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
379
                    self.master_branch, master_bound_location)
380
381
        # TODO: jam 20051230 We could automatically push local
382
        #       commits to the remote branch if they would fit.
383
        #       But for now, just require remote to be identical
384
        #       to local.
385
        
386
        # Make sure the local branch is identical to the master
387
        master_rh = self.master_branch.revision_history()
388
        local_rh = self.branch.revision_history()
389
        if local_rh != master_rh:
390
            raise errors.BoundBranchOutOfDate(self.branch,
391
                    self.master_branch)
392
393
        # Now things are ready to change the master branch
394
        # so grab the lock
395
        self.bound_branch = self.branch
396
        self.master_branch.lock_write()
1614.1.1 by Aaron Bentley
Fixed master locking in commit
397
        self.master_locked = True
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
398
####        
399
####        # Check to see if we have any pending merges. If we do
400
####        # those need to be pushed into the master branch
401
####        pending_merges = self.work_tree.pending_merges()
402
####        if pending_merges:
403
####            for revision_id in pending_merges:
404
####                self.master_branch.repository.fetch(self.bound_branch.repository,
405
####                                                    revision_id=revision_id)
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
406
407
    def _cleanup_bound_branch(self):
408
        """Executed at the end of a try/finally to cleanup a bound branch.
409
410
        If the branch wasn't bound, this is a no-op.
411
        If it was, it resents self.branch to the local branch, instead
412
        of being the master.
413
        """
414
        if not self.bound_branch:
415
            return
1614.1.1 by Aaron Bentley
Fixed master locking in commit
416
        if self.master_locked:
417
            self.master_branch.unlock()
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
418
1390 by Robert Collins
pair programming worx... merge integration and weave
419
    def _escape_commit_message(self):
420
        """Replace xml-incompatible control characters."""
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
421
        # Python strings can include characters that can't be
422
        # represented in well-formed XML; escape characters that
423
        # aren't listed in the XML specification
424
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
1390 by Robert Collins
pair programming worx... merge integration and weave
425
        self.message, escape_count = re.subn(
1393.4.2 by Harald Meland
Cleanup + better test of commit-msg control character escape code.
426
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
427
            lambda match: match.group(0).encode('unicode_escape'),
1390 by Robert Collins
pair programming worx... merge integration and weave
428
            self.message)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
429
        if escape_count:
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
430
            self.reporter.escaped(escape_count, self.message)
1223 by Martin Pool
- store inventories in weave
431
432
    def _gather_parents(self):
1092.2.25 by Robert Collins
support ghosts in commits
433
        """Record the parents of a merge for merge detection."""
1457.1.14 by Robert Collins
Move pending_merges() to WorkingTree.
434
        pending_merges = self.work_tree.pending_merges()
1223 by Martin Pool
- store inventories in weave
435
        self.parents = []
1408 by Robert Collins
we do not need revision_trees in commit, parent inventories are sufficient
436
        self.parent_invs = []
1092.2.25 by Robert Collins
support ghosts in commits
437
        self.present_parents = []
1241 by Martin Pool
- rename last_patch to last_revision
438
        precursor_id = self.branch.last_revision()
1223 by Martin Pool
- store inventories in weave
439
        if precursor_id:
440
            self.parents.append(precursor_id)
441
        self.parents += pending_merges
1092.2.25 by Robert Collins
support ghosts in commits
442
        for revision in self.parents:
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
443
            if self.branch.repository.has_revision(revision):
444
                inventory = self.branch.repository.get_inventory(revision)
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
445
                self.parent_invs.append(inventory)
1092.2.25 by Robert Collins
support ghosts in commits
446
                self.present_parents.append(revision)
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
447
448
    def _check_parents_present(self):
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
449
        for parent_id in self.parents:
1270 by Martin Pool
- fix recording of merged ancestry lines
450
            mutter('commit parent revision {%s}', parent_id)
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
451
            if not self.branch.repository.has_revision(parent_id):
1092.2.25 by Robert Collins
support ghosts in commits
452
                if parent_id == self.branch.last_revision():
1185.12.9 by Aaron Bentley
Removed crude language
453
                    warning("parent is missing %r", parent_id)
1092.2.25 by Robert Collins
support ghosts in commits
454
                    raise HistoryMissing(self.branch, 'revision', parent_id)
455
                else:
456
                    mutter("commit will ghost revision %r", parent_id)
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
457
            
1189 by Martin Pool
- BROKEN: partial support for commit into weave
458
    def _make_revision(self):
459
        """Record a new revision object for this commit."""
1570.1.2 by Robert Collins
Import bzrtools' 'fix' command as 'bzr reconcile.'
460
        rev = Revision(timestamp=self.timestamp,
461
                       timezone=self.timezone,
462
                       committer=self.committer,
463
                       message=self.message,
464
                       inventory_sha1=self.inv_sha1,
465
                       revision_id=self.rev_id,
466
                       properties=self.revprops)
467
        rev.parent_ids = self.parents
468
        self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
469
470
    def _remove_deleted(self):
1248 by Martin Pool
- new weave based cleanup [broken]
471
        """Remove deleted files from the working inventories.
472
473
        This is done prior to taking the working inventory as the
474
        basis for the new committed inventory.
475
476
        This returns true if any files
477
        *that existed in the basis inventory* were deleted.
478
        Files that were added and deleted
479
        in the working copy don't matter.
480
        """
1254 by Martin Pool
- fix handling of selective commit with deleted files
481
        specific = self.specific_files
482
        deleted_ids = []
483
        for path, ie in self.work_inv.iter_entries():
484
            if specific and not is_inside_any(specific, path):
485
                continue
486
            if not self.work_tree.has_filename(path):
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
487
                self.reporter.missing(path)
1185.12.5 by Aaron Bentley
Fixed ordering issue in Commit._remove_deleted
488
                deleted_ids.append((path, ie.file_id))
1254 by Martin Pool
- fix handling of selective commit with deleted files
489
        if deleted_ids:
1185.12.5 by Aaron Bentley
Fixed ordering issue in Commit._remove_deleted
490
            deleted_ids.sort(reverse=True)
491
            for path, file_id in deleted_ids:
1248 by Martin Pool
- new weave based cleanup [broken]
492
                del self.work_inv[file_id]
1457.1.11 by Robert Collins
Move _write_inventory to WorkingTree.
493
            self.work_tree._write_inventory(self.work_inv)
1248 by Martin Pool
- new weave based cleanup [broken]
494
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
495
    def _store_snapshot(self):
496
        """Pass over inventory and record a snapshot.
1303 by Martin Pool
- commit updates entry_version
497
1092.2.21 by Robert Collins
convert name_version to revision in inventory entries
498
        Entries get a new revision when they are modified in 
499
        any way, which includes a merge with a new set of
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
500
        parents that have the same entry. 
1092.2.21 by Robert Collins
convert name_version to revision in inventory entries
501
        """
1303 by Martin Pool
- commit updates entry_version
502
        # XXX: Need to think more here about when the user has
503
        # made a specific decision on a particular value -- c.f.
504
        # mark-merge.  
505
        for path, ie in self.new_inv.iter_entries():
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
506
            previous_entries = ie.find_previous_heads(
1616.1.4 by Martin Pool
Verbose commit shouldn't talk about every unchanged file.
507
                self.parent_invs,
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
508
                self.weave_store,
509
                self.branch.repository.get_transaction())
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
510
            if ie.revision is None:
511
                change = ie.snapshot(self.rev_id, path, previous_entries,
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
512
                                     self.work_tree, self.weave_store,
513
                                     self.branch.get_transaction())
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
514
            else:
515
                change = "unchanged"
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
516
            self.reporter.snapshot_change(change, path)
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
517
518
    def _populate_new_inv(self):
519
        """Build revision inventory.
520
521
        This creates a new empty inventory. Depending on
522
        which files are selected for commit, and what is present in the
523
        current tree, the new inventory is populated. inventory entries 
524
        which are candidates for modification have their revision set to
525
        None; inventory entries that are carried over untouched have their
526
        revision set to their prior value.
1301 by Martin Pool
- more docs in commit code
527
        """
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
528
        mutter("Selecting files for commit with filter %s", self.specific_files)
529
        self.new_inv = Inventory()
1249 by Martin Pool
- improvements to weave commit [broken]
530
        for path, new_ie in self.work_inv.iter_entries():
531
            file_id = new_ie.file_id
532
            mutter('check %s {%s}', path, new_ie.file_id)
1248 by Martin Pool
- new weave based cleanup [broken]
533
            if self.specific_files:
534
                if not is_inside_any(self.specific_files, path):
1249 by Martin Pool
- improvements to weave commit [broken]
535
                    mutter('%s not selected for commit', path)
1416 by Robert Collins
when committing a specific file, include all its parents
536
                    self._carry_entry(file_id)
1249 by Martin Pool
- improvements to weave commit [broken]
537
                    continue
1416 by Robert Collins
when committing a specific file, include all its parents
538
                else:
539
                    # this is selected, ensure its parents are too.
540
                    parent_id = new_ie.parent_id
541
                    while parent_id != ROOT_ID:
542
                        if not self.new_inv.has_id(parent_id):
543
                            ie = self._select_entry(self.work_inv[parent_id])
544
                            mutter('%s selected for commit because of %s',
545
                                   self.new_inv.id2path(parent_id), path)
546
547
                        ie = self.new_inv[parent_id]
548
                        if ie.revision is not None:
549
                            ie.revision = None
550
                            mutter('%s selected for commit because of %s',
551
                                   self.new_inv.id2path(parent_id), path)
552
                        parent_id = ie.parent_id
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
553
            mutter('%s selected for commit', path)
1416 by Robert Collins
when committing a specific file, include all its parents
554
            self._select_entry(new_ie)
555
556
    def _select_entry(self, new_ie):
557
        """Make new_ie be considered for committing."""
558
        ie = new_ie.copy()
559
        ie.revision = None
560
        self.new_inv.add(ie)
561
        return ie
562
563
    def _carry_entry(self, file_id):
1285 by Martin Pool
- fix bug in committing files that are renamed but not modified
564
        """Carry the file unchanged from the basis revision."""
1249 by Martin Pool
- improvements to weave commit [broken]
565
        if self.basis_inv.has_id(file_id):
566
            self.new_inv.add(self.basis_inv[file_id].copy())
1248 by Martin Pool
- new weave based cleanup [broken]
567
568
    def _report_deletes(self):
569
        for file_id in self.basis_inv:
570
            if file_id not in self.new_inv:
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
571
                self.reporter.deleted(self.basis_inv.id2path(file_id))
1248 by Martin Pool
- new weave based cleanup [broken]
572
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
573
def _gen_revision_id(config, when):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
574
    """Return new revision-id."""
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
575
    s = '%s-%s-' % (config.user_email(), compact_date(when))
1189 by Martin Pool
- BROKEN: partial support for commit into weave
576
    s += hexlify(rand_bytes(8))
577
    return s