~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 23:43:18 UTC
  • mto: This revision was merged to the branch mainline in revision 2027.
  • Revision ID: john@arbash-meinel.com-20060920234318-05de23e98f7e7876
Move out export tests from test_too_much, refactor
and re-enable doc tests for export.get_root_name()

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
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?
20
 
 
21
 
## XXX: If we merged two versions of a file then we still need to
22
 
## create a new version representing that merge, even if it didn't
23
 
## change from the parent.
24
 
 
25
 
## TODO: Read back the just-generated changeset, and make sure it
26
 
## applies and recreates the right state.
27
 
 
28
 
 
29
 
 
 
18
# XXX: Can we do any better about making interrupted commits change
 
19
# nothing?  
 
20
 
 
21
# TODO: Separate 'prepare' phase where we find a list of potentially
 
22
# committed files.  We then can then pause the commit to prompt for a
 
23
# commit message, knowing the summary will be the same as what's
 
24
# actually used for the commit.  (But perhaps simpler to simply get
 
25
# the tree status, then use that for a selective commit?)
 
26
 
 
27
# The newly committed revision is going to have a shape corresponding
 
28
# to that of the working inventory.  Files that are not in the
 
29
# working tree and that were in the predecessor are reported as
 
30
# removed --- this can include files that were either removed from the
 
31
# inventory or deleted in the working tree.  If they were only
 
32
# deleted from disk, they are removed from the working inventory.
 
33
 
 
34
# We then consider the remaining entries, which will be in the new
 
35
# version.  Directory entries are simply copied across.  File entries
 
36
# must be checked to see if a new version of the file should be
 
37
# recorded.  For each parent revision inventory, we check to see what
 
38
# version of the file was present.  If the file was present in at
 
39
# least one tree, and if it was the same version in all the trees,
 
40
# then we can just refer to that version.  Otherwise, a new version
 
41
# representing the merger of the file versions must be added.
 
42
 
 
43
# TODO: Update hashcache before and after - or does the WorkingTree
 
44
# look after that?
 
45
 
 
46
# TODO: Rather than mashing together the ancestry and storing it back,
 
47
# perhaps the weave should have single method which does it all in one
 
48
# go, avoiding a lot of redundant work.
 
49
 
 
50
# TODO: Perhaps give a warning if one of the revisions marked as
 
51
# merged is already in the ancestry, and then don't record it as a
 
52
# distinct parent.
 
53
 
 
54
# TODO: If the file is newly merged but unchanged from the version it
 
55
# merges from, then it should still be reported as newly added
 
56
# relative to the basis revision.
 
57
 
 
58
# TODO: Do checks that the tree can be committed *before* running the 
 
59
# editor; this should include checks for a pointless commit and for 
 
60
# unknown or missing files.
 
61
 
 
62
# TODO: If commit fails, leave the message in a file somewhere.
 
63
 
 
64
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
 
65
# the rest of the code; add a deprecation of the old name.
30
66
 
31
67
import os
 
68
import re
32
69
import sys
33
70
import time
34
 
import tempfile
35
 
import sha
36
71
 
37
 
from binascii import hexlify
38
72
from cStringIO import StringIO
39
73
 
40
 
from bzrlib.osutils import (local_time_offset, username,
41
 
                            rand_bytes, compact_date, user_email,
42
 
                            kind_marker, is_inside_any, quotefn,
43
 
                            sha_string, sha_file, isdir, isfile)
44
 
from bzrlib.branch import gen_file_id
45
 
from bzrlib.errors import BzrError, PointlessCommit
46
 
from bzrlib.revision import Revision, RevisionReference
47
 
from bzrlib.trace import mutter, note
 
74
import bzrlib.config
 
75
import bzrlib.errors as errors
 
76
from bzrlib.errors import (BzrError, PointlessCommit,
 
77
                           ConflictsInTree,
 
78
                           StrictCommitFailed
 
79
                           )
 
80
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
81
                            is_inside_or_parent_of_any,
 
82
                            quotefn, sha_file, split_lines)
 
83
from bzrlib.testament import Testament
 
84
from bzrlib.trace import mutter, note, warning
48
85
from bzrlib.xml5 import serializer_v5
49
 
from bzrlib.inventory import Inventory
50
 
from bzrlib.delta import compare_trees
51
 
from bzrlib.weave import Weave
52
 
from bzrlib.weavefile import read_weave, write_weave_v5
53
 
from bzrlib.atomicfile import AtomicFile
54
 
 
55
 
 
56
 
def commit(*args, **kwargs):
57
 
    """Commit a new revision to a branch.
58
 
 
59
 
    Function-style interface for convenience of old callers.
60
 
 
61
 
    New code should use the Commit class instead.
62
 
    """
63
 
    Commit().commit(*args, **kwargs)
 
86
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
 
87
from bzrlib import symbol_versioning
 
88
from bzrlib.symbol_versioning import (deprecated_passed,
 
89
        deprecated_function,
 
90
        DEPRECATED_PARAMETER)
 
91
from bzrlib.workingtree import WorkingTree
64
92
 
65
93
 
66
94
class NullCommitReporter(object):
67
95
    """I report on progress of a commit."""
68
 
    def added(self, path):
69
 
        pass
70
 
 
71
 
    def removed(self, path):
72
 
        pass
73
 
 
74
 
    def renamed(self, old_path, new_path):
 
96
 
 
97
    def snapshot_change(self, change, path):
 
98
        pass
 
99
 
 
100
    def completed(self, revno, rev_id):
 
101
        pass
 
102
 
 
103
    def deleted(self, file_id):
 
104
        pass
 
105
 
 
106
    def escaped(self, escape_count, message):
 
107
        pass
 
108
 
 
109
    def missing(self, path):
 
110
        pass
 
111
 
 
112
    def renamed(self, change, old_path, new_path):
75
113
        pass
76
114
 
77
115
 
78
116
class ReportCommitToLog(NullCommitReporter):
79
 
    def added(self, path):
80
 
        note('added %s', path)
81
 
 
82
 
    def removed(self, path):
83
 
        note('removed %s', path)
84
 
 
85
 
    def renamed(self, old_path, new_path):
86
 
        note('renamed %s => %s', old_path, new_path)
 
117
 
 
118
    # this may be more useful if 'note' was replaced by an overridable
 
119
    # method on self, which would allow more trivial subclassing.
 
120
    # alternative, a callable could be passed in, allowing really trivial
 
121
    # reuse for some uis. RBC 20060511
 
122
 
 
123
    def snapshot_change(self, change, path):
 
124
        if change == 'unchanged':
 
125
            return
 
126
        note("%s %s", change, path)
 
127
 
 
128
    def completed(self, revno, rev_id):
 
129
        note('Committed revision %d.', revno)
 
130
    
 
131
    def deleted(self, file_id):
 
132
        note('deleted %s', file_id)
 
133
 
 
134
    def escaped(self, escape_count, message):
 
135
        note("replaced %d control characters in message", escape_count)
 
136
 
 
137
    def missing(self, path):
 
138
        note('missing %s', path)
 
139
 
 
140
    def renamed(self, change, old_path, new_path):
 
141
        note('%s %s => %s', change, old_path, new_path)
87
142
 
88
143
 
89
144
class Commit(object):
99
154
            working inventory.
100
155
    """
101
156
    def __init__(self,
102
 
                 reporter=None):
 
157
                 reporter=None,
 
158
                 config=None):
103
159
        if reporter is not None:
104
160
            self.reporter = reporter
105
161
        else:
106
162
            self.reporter = NullCommitReporter()
107
 
 
 
163
        if config is not None:
 
164
            self.config = config
 
165
        else:
 
166
            self.config = None
108
167
        
109
168
    def commit(self,
110
 
               branch, message,
 
169
               branch=DEPRECATED_PARAMETER, message=None,
111
170
               timestamp=None,
112
171
               timezone=None,
113
172
               committer=None,
114
173
               specific_files=None,
115
174
               rev_id=None,
116
 
               allow_pointless=True):
 
175
               allow_pointless=True,
 
176
               strict=False,
 
177
               verbose=False,
 
178
               revprops=None,
 
179
               working_tree=None,
 
180
               local=False,
 
181
               reporter=None,
 
182
               config=None):
117
183
        """Commit working copy as a new revision.
118
184
 
119
 
        The basic approach is to add all the file texts into the
120
 
        store, then the inventory, then make a new revision pointing
121
 
        to that inventory and store that.
122
 
 
123
 
        This is not quite safe if the working copy changes during the
124
 
        commit; for the moment that is simply not allowed.  A better
125
 
        approach is to make a temporary copy of the files before
126
 
        computing their hashes, and then add those hashes in turn to
127
 
        the inventory.  This should mean at least that there are no
128
 
        broken hash pointers.  There is no way we can get a snapshot
129
 
        of the whole directory at an instant.  This would also have to
130
 
        be robust against files disappearing, moving, etc.  So the
131
 
        whole thing is a bit hard.
132
 
 
133
 
        This raises PointlessCommit if there are no changes, no new merges,
134
 
        and allow_pointless  is false.
 
185
        branch -- the deprecated branch to commit to. New callers should pass in 
 
186
                  working_tree instead
 
187
 
 
188
        message -- the commit message, a mandatory parameter
135
189
 
136
190
        timestamp -- if not None, seconds-since-epoch for a
137
191
             postdated/predated commit.
138
192
 
139
 
        specific_files
140
 
            If true, commit only those files.
 
193
        specific_files -- If true, commit only those files.
141
194
 
142
 
        rev_id
143
 
            If set, use this as the new revision id.
 
195
        rev_id -- If set, use this as the new revision id.
144
196
            Useful for test or import commands that need to tightly
145
197
            control what revisions are assigned.  If you duplicate
146
198
            a revision id that exists elsewhere it is your own fault.
147
199
            If null (default), a time/random revision id is generated.
 
200
 
 
201
        allow_pointless -- If true (default), commit even if nothing
 
202
            has changed and no merges are recorded.
 
203
 
 
204
        strict -- If true, don't allow a commit if the working tree
 
205
            contains unknown files.
 
206
 
 
207
        revprops -- Properties for new revision
 
208
        :param local: Perform a local only commit.
148
209
        """
149
 
 
150
 
        self.branch = branch
151
 
        self.branch.lock_write()
152
 
        self.rev_id = rev_id
 
210
        mutter('preparing to commit')
 
211
 
 
212
        if deprecated_passed(branch):
 
213
            symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
 
214
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
 
215
                 DeprecationWarning, stacklevel=2)
 
216
            self.branch = branch
 
217
            self.work_tree = self.branch.bzrdir.open_workingtree()
 
218
        elif working_tree is None:
 
219
            raise BzrError("One of branch and working_tree must be passed into commit().")
 
220
        else:
 
221
            self.work_tree = working_tree
 
222
            self.branch = self.work_tree.branch
 
223
        if message is None:
 
224
            raise BzrError("The message keyword parameter is required for commit().")
 
225
 
 
226
        self.bound_branch = None
 
227
        self.local = local
 
228
        self.master_branch = None
 
229
        self.master_locked = False
 
230
        self.rev_id = None
153
231
        self.specific_files = specific_files
154
232
        self.allow_pointless = allow_pointless
155
233
 
156
 
        if timestamp is None:
157
 
            self.timestamp = time.time()
158
 
        else:
159
 
            self.timestamp = long(timestamp)
160
 
            
161
 
        if committer is None:
162
 
            self.committer = username(self.branch)
163
 
        else:
164
 
            assert isinstance(committer, basestring), type(committer)
165
 
            self.committer = committer
166
 
 
167
 
        if timezone is None:
168
 
            self.timezone = local_time_offset()
169
 
        else:
170
 
            self.timezone = int(timezone)
171
 
 
172
 
        assert isinstance(message, basestring), type(message)
173
 
        self.message = message
174
 
 
 
234
        if reporter is None and self.reporter is None:
 
235
            self.reporter = NullCommitReporter()
 
236
        elif reporter is not None:
 
237
            self.reporter = reporter
 
238
 
 
239
        self.work_tree.lock_write()
 
240
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
175
241
        try:
176
 
            # First walk over the working inventory; and both update that
177
 
            # and also build a new revision inventory.  The revision
178
 
            # inventory needs to hold the text-id, sha1 and size of the
179
 
            # actual file versions committed in the revision.  (These are
180
 
            # not present in the working inventory.)  We also need to
181
 
            # detect missing/deleted files, and remove them from the
182
 
            # working inventory.
183
 
 
184
 
            self.work_tree = self.branch.working_tree()
 
242
            # Cannot commit with conflicts present.
 
243
            if len(self.work_tree.conflicts())>0:
 
244
                raise ConflictsInTree
 
245
 
 
246
            # setup the bound branch variables as needed.
 
247
            self._check_bound_branch()
 
248
 
 
249
            # check for out of date working trees
 
250
            try:
 
251
                first_tree_parent = self.work_tree.get_parent_ids()[0]
 
252
            except IndexError:
 
253
                # if there are no parents, treat our parent as 'None'
 
254
                # this is so that we still consier the master branch
 
255
                # - in a checkout scenario the tree may have no
 
256
                # parents but the branch may do.
 
257
                first_tree_parent = None
 
258
            master_last = self.master_branch.last_revision()
 
259
            if (master_last is not None and
 
260
                master_last != first_tree_parent):
 
261
                raise errors.OutOfDateTree(self.work_tree)
 
262
    
 
263
            if strict:
 
264
                # raise an exception as soon as we find a single unknown.
 
265
                for unknown in self.work_tree.unknowns():
 
266
                    raise StrictCommitFailed()
 
267
                   
 
268
            if self.config is None:
 
269
                self.config = self.branch.get_config()
 
270
      
 
271
            if isinstance(message, str):
 
272
                message = message.decode(bzrlib.user_encoding)
 
273
            assert isinstance(message, unicode), type(message)
 
274
            self.message = message
 
275
            self._escape_commit_message()
 
276
 
185
277
            self.work_inv = self.work_tree.inventory
186
 
            self.basis_tree = self.branch.basis_tree()
 
278
            self.basis_tree = self.work_tree.basis_tree()
187
279
            self.basis_inv = self.basis_tree.inventory
188
 
 
189
 
            self.pending_merges = self.branch.pending_merges()
190
 
            if self.pending_merges:
191
 
                raise NotImplementedError("sorry, can't commit merges to the weave format yet")
192
 
            
193
 
            if self.rev_id is None:
194
 
                self.rev_id = _gen_revision_id(self.branch, time.time())
195
 
 
196
 
            # todo: update hashcache
197
 
            self.delta = compare_trees(self.basis_tree, self.work_tree,
198
 
                                       specific_files=self.specific_files)
199
 
 
200
 
            if not (self.delta.has_changed()
201
 
                    or self.allow_pointless
202
 
                    or self.pending_merges):
203
 
                raise PointlessCommit()
204
 
 
205
 
            self.new_inv = self.basis_inv.copy()
206
 
 
207
 
            self.delta.show(sys.stdout)
208
 
 
 
280
            # one to finish, one for rev and inventory, and one for each
 
281
            # inventory entry, and the same for the new inventory.
 
282
            # note that this estimate is too long when we do a partial tree
 
283
            # commit which excludes some new files from being considered.
 
284
            # The estimate is corrected when we populate the new inv.
 
285
            self.pb_total = len(self.work_inv) + 5
 
286
            self.pb_count = 0
 
287
 
 
288
            self._gather_parents()
 
289
            if len(self.parents) > 1 and self.specific_files:
 
290
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
 
291
                        self.specific_files)
 
292
            
 
293
            self.builder = self.branch.get_commit_builder(self.parents, 
 
294
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
295
            
209
296
            self._remove_deleted()
210
 
            self._store_files()
211
 
 
212
 
            self.branch._write_inventory(self.work_inv)
213
 
            self._record_inventory()
214
 
 
215
 
            self._make_revision()
216
 
            note('committted r%d {%s}', (self.branch.revno() + 1),
217
 
                 self.rev_id)
 
297
            self._populate_new_inv()
 
298
            self._report_deletes()
 
299
 
 
300
            self._check_pointless()
 
301
 
 
302
            self._emit_progress_update()
 
303
            # TODO: Now the new inventory is known, check for conflicts and
 
304
            # prompt the user for a commit message.
 
305
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
306
            # weave lines, because nothing should be recorded until it is known
 
307
            # that commit will succeed.
 
308
            self.builder.finish_inventory()
 
309
            self._emit_progress_update()
 
310
            self.rev_id = self.builder.commit(self.message)
 
311
            self._emit_progress_update()
 
312
            # revision data is in the local branch now.
 
313
            
 
314
            # upload revision data to the master.
 
315
            # this will propagate merged revisions too if needed.
 
316
            if self.bound_branch:
 
317
                self.master_branch.repository.fetch(self.branch.repository,
 
318
                                                    revision_id=self.rev_id)
 
319
                # now the master has the revision data
 
320
                # 'commit' to the master first so a timeout here causes the local
 
321
                # branch to be out of date
 
322
                self.master_branch.append_revision(self.rev_id)
 
323
 
 
324
            # and now do the commit locally.
218
325
            self.branch.append_revision(self.rev_id)
219
 
            self.branch.set_pending_merges([])
 
326
 
 
327
            # if the builder gave us the revisiontree it created back, we
 
328
            # could use it straight away here.
 
329
            # TODO: implement this.
 
330
            self.work_tree.set_parent_trees([(self.rev_id,
 
331
                self.branch.repository.revision_tree(self.rev_id))])
 
332
            # now the work tree is up to date with the branch
 
333
            
 
334
            self.reporter.completed(self.branch.revno(), self.rev_id)
 
335
            if self.config.post_commit() is not None:
 
336
                hooks = self.config.post_commit().split(' ')
 
337
                # this would be nicer with twisted.python.reflect.namedAny
 
338
                for hook in hooks:
 
339
                    result = eval(hook + '(branch, rev_id)',
 
340
                                  {'branch':self.branch,
 
341
                                   'bzrlib':bzrlib,
 
342
                                   'rev_id':self.rev_id})
 
343
            self._emit_progress_update()
220
344
        finally:
221
 
            self.branch.unlock()
222
 
 
223
 
 
224
 
    def _record_inventory(self):
225
 
        inv_tmp = StringIO()
226
 
        serializer_v5.write_inventory(self.new_inv, inv_tmp)
227
 
        self.inv_sha1 = sha_string(inv_tmp.getvalue())
228
 
        inv_tmp.seek(0)
229
 
        self.branch.inventory_store.add(inv_tmp, self.rev_id)
230
 
 
231
 
 
232
 
    def _make_revision(self):
233
 
        """Record a new revision object for this commit."""
234
 
        self.rev = Revision(timestamp=self.timestamp,
235
 
                            timezone=self.timezone,
236
 
                            committer=self.committer,
237
 
                            message=self.message,
238
 
                            inventory_sha1=self.inv_sha1,
239
 
                            revision_id=self.rev_id)
240
 
 
241
 
        self.rev.parents = []
242
 
        precursor_id = self.branch.last_patch()
243
 
        if precursor_id:
244
 
            self.rev.parents.append(RevisionReference(precursor_id))
245
 
        for merge_rev in self.pending_merges:
246
 
            rev.parents.append(RevisionReference(merge_rev))
247
 
 
248
 
        rev_tmp = tempfile.TemporaryFile()
249
 
        serializer_v5.write_revision(self.rev, rev_tmp)
250
 
        rev_tmp.seek(0)
251
 
        self.branch.revision_store.add(rev_tmp, self.rev_id)
252
 
        mutter('new revision_id is {%s}', self.rev_id)
253
 
 
 
345
            self._cleanup()
 
346
        return self.rev_id
 
347
 
 
348
    def _check_pointless(self):
 
349
        if self.allow_pointless:
 
350
            return
 
351
        # A merge with no effect on files
 
352
        if len(self.parents) > 1:
 
353
            return
 
354
        # work around the fact that a newly-initted tree does differ from its
 
355
        # basis
 
356
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
357
            return
 
358
        if (len(self.builder.new_inventory) != 1 and
 
359
            self.builder.new_inventory != self.basis_inv):
 
360
            return
 
361
        raise PointlessCommit()
 
362
 
 
363
    def _check_bound_branch(self):
 
364
        """Check to see if the local branch is bound.
 
365
 
 
366
        If it is bound, then most of the commit will actually be
 
367
        done using the remote branch as the target branch.
 
368
        Only at the end will the local branch be updated.
 
369
        """
 
370
        if self.local and not self.branch.get_bound_location():
 
371
            raise errors.LocalRequiresBoundBranch()
 
372
 
 
373
        if not self.local:
 
374
            self.master_branch = self.branch.get_master_branch()
 
375
 
 
376
        if not self.master_branch:
 
377
            # make this branch the reference branch for out of date checks.
 
378
            self.master_branch = self.branch
 
379
            return
 
380
 
 
381
        # If the master branch is bound, we must fail
 
382
        master_bound_location = self.master_branch.get_bound_location()
 
383
        if master_bound_location:
 
384
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
385
                    self.master_branch, master_bound_location)
 
386
 
 
387
        # TODO: jam 20051230 We could automatically push local
 
388
        #       commits to the remote branch if they would fit.
 
389
        #       But for now, just require remote to be identical
 
390
        #       to local.
 
391
        
 
392
        # Make sure the local branch is identical to the master
 
393
        master_rh = self.master_branch.revision_history()
 
394
        local_rh = self.branch.revision_history()
 
395
        if local_rh != master_rh:
 
396
            raise errors.BoundBranchOutOfDate(self.branch,
 
397
                    self.master_branch)
 
398
 
 
399
        # Now things are ready to change the master branch
 
400
        # so grab the lock
 
401
        self.bound_branch = self.branch
 
402
        self.master_branch.lock_write()
 
403
        self.master_locked = True
 
404
 
 
405
    def _cleanup(self):
 
406
        """Cleanup any open locks, progress bars etc."""
 
407
        cleanups = [self._cleanup_bound_branch,
 
408
                    self.work_tree.unlock,
 
409
                    self.pb.finished]
 
410
        found_exception = None
 
411
        for cleanup in cleanups:
 
412
            try:
 
413
                cleanup()
 
414
            # we want every cleanup to run no matter what.
 
415
            # so we have a catchall here, but we will raise the
 
416
            # last encountered exception up the stack: and
 
417
            # typically this will be useful enough.
 
418
            except Exception, e:
 
419
                found_exception = e
 
420
        if found_exception is not None: 
 
421
            # don't do a plan raise, because the last exception may have been
 
422
            # trashed, e is our sure-to-work exception even though it loses the
 
423
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
424
            # exc_info and if its the same one do a plain raise otherwise 
 
425
            # 'raise e' as we do now.
 
426
            raise e
 
427
 
 
428
    def _cleanup_bound_branch(self):
 
429
        """Executed at the end of a try/finally to cleanup a bound branch.
 
430
 
 
431
        If the branch wasn't bound, this is a no-op.
 
432
        If it was, it resents self.branch to the local branch, instead
 
433
        of being the master.
 
434
        """
 
435
        if not self.bound_branch:
 
436
            return
 
437
        if self.master_locked:
 
438
            self.master_branch.unlock()
 
439
 
 
440
    def _escape_commit_message(self):
 
441
        """Replace xml-incompatible control characters."""
 
442
        # FIXME: RBC 20060419 this should be done by the revision
 
443
        # serialiser not by commit. Then we can also add an unescaper
 
444
        # in the deserializer and start roundtripping revision messages
 
445
        # precisely. See repository_implementations/test_repository.py
 
446
        
 
447
        # Python strings can include characters that can't be
 
448
        # represented in well-formed XML; escape characters that
 
449
        # aren't listed in the XML specification
 
450
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
451
        self.message, escape_count = re.subn(
 
452
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
453
            lambda match: match.group(0).encode('unicode_escape'),
 
454
            self.message)
 
455
        if escape_count:
 
456
            self.reporter.escaped(escape_count, self.message)
 
457
 
 
458
    def _gather_parents(self):
 
459
        """Record the parents of a merge for merge detection."""
 
460
        # TODO: Make sure that this list doesn't contain duplicate 
 
461
        # entries and the order is preserved when doing this.
 
462
        self.parents = self.work_tree.get_parent_ids()
 
463
        self.parent_invs = []
 
464
        for revision in self.parents:
 
465
            if self.branch.repository.has_revision(revision):
 
466
                mutter('commit parent revision {%s}', revision)
 
467
                inventory = self.branch.repository.get_inventory(revision)
 
468
                self.parent_invs.append(inventory)
 
469
            else:
 
470
                mutter('commit parent ghost revision {%s}', revision)
254
471
 
255
472
    def _remove_deleted(self):
256
 
        """Remove deleted files from the working and stored inventories."""
257
 
        for path, id, kind in self.delta.removed:
258
 
            if self.work_inv.has_id(id):
259
 
                del self.work_inv[id]
260
 
            if self.new_inv.has_id(id):
261
 
                del self.new_inv[id]
262
 
 
263
 
 
264
 
 
265
 
    def _store_files(self):
266
 
        """Store new texts of modified/added files."""
267
 
        # We must make sure that directories are added before anything
268
 
        # inside them is added.  the files within the delta report are
269
 
        # sorted by path so we know the directory will come before its
270
 
        # contents. 
271
 
        for path, file_id, kind in self.delta.added:
272
 
            if kind != 'file':
273
 
                ie = self.work_inv[file_id].copy()
274
 
                self.new_inv.add(ie)
275
 
            else:
276
 
                self._store_file_text(file_id)
277
 
 
278
 
        for path, file_id, kind in self.delta.modified:
279
 
            if kind != 'file':
280
 
                continue
281
 
            self._store_file_text(file_id)
282
 
 
283
 
        for old_path, new_path, file_id, kind, text_modified in self.delta.renamed:
284
 
            if kind != 'file':
285
 
                continue
286
 
            if not text_modified:
287
 
                continue
288
 
            self._store_file_text(file_id)
289
 
 
290
 
 
291
 
    def _store_file_text(self, file_id):
292
 
        """Store updated text for one modified or added file."""
293
 
        note('store new text for {%s} in revision {%s}',
294
 
             file_id, self.rev_id)
295
 
        new_lines = self.work_tree.get_file(file_id).readlines()
296
 
        if file_id in self.new_inv:     # was in basis inventory
297
 
            ie = self.new_inv[file_id]
298
 
            assert ie.file_id == file_id
299
 
            assert file_id in self.basis_inv
300
 
            assert self.basis_inv[file_id].kind == 'file'
301
 
            old_version = self.basis_inv[file_id].text_version
302
 
            file_parents = [old_version]
303
 
        else:                           # new in this revision
304
 
            ie = self.work_inv[file_id].copy()
305
 
            self.new_inv.add(ie)
306
 
            assert file_id not in self.basis_inv
307
 
            file_parents = []
308
 
        assert ie.kind == 'file'
309
 
        self._add_text_to_weave(file_id, new_lines, file_parents)
310
 
        # make a new inventory entry for this file, using whatever
311
 
        # it had in the working copy, plus details on the new text
312
 
        ie.text_sha1 = _sha_strings(new_lines)
313
 
        ie.text_size = sum(map(len, new_lines))
314
 
        ie.text_version = self.rev_id
315
 
        ie.entry_version = self.rev_id
316
 
 
317
 
 
318
 
    def _add_text_to_weave(self, file_id, new_lines, parents):
319
 
        weave_fn = self.branch.controlfilename(['weaves', file_id+'.weave'])
320
 
        if os.path.exists(weave_fn):
321
 
            w = read_weave(file(weave_fn, 'rb'))
322
 
        else:
323
 
            w = Weave()
324
 
        # XXX: Should set the appropriate parents by looking for this file_id
325
 
        # in all revision parents
326
 
        parent_idxs = map(w.lookup, parents)
327
 
        w.add(self.rev_id, parent_idxs, new_lines)
328
 
        af = AtomicFile(weave_fn)
329
 
        try:
330
 
            write_weave_v5(w, af)
331
 
            af.commit()
332
 
        finally:
333
 
            af.close()
334
 
 
335
 
 
336
 
def _gen_revision_id(branch, when):
337
 
    """Return new revision-id."""
338
 
    s = '%s-%s-' % (user_email(branch), compact_date(when))
339
 
    s += hexlify(rand_bytes(8))
340
 
    return s
341
 
 
342
 
 
343
 
def _sha_strings(strings):
344
 
    """Return the sha-1 of concatenation of strings"""
345
 
    s = sha.new()
346
 
    map(s.update, strings)
347
 
    return s.hexdigest()
 
473
        """Remove deleted files from the working inventories.
 
474
 
 
475
        This is done prior to taking the working inventory as the
 
476
        basis for the new committed inventory.
 
477
 
 
478
        This returns true if any files
 
479
        *that existed in the basis inventory* were deleted.
 
480
        Files that were added and deleted
 
481
        in the working copy don't matter.
 
482
        """
 
483
        specific = self.specific_files
 
484
        deleted_ids = []
 
485
        deleted_paths = set()
 
486
        for path, ie in self.work_inv.iter_entries():
 
487
            if is_inside_any(deleted_paths, path):
 
488
                # The tree will delete the required ids recursively.
 
489
                continue
 
490
            if specific and not is_inside_any(specific, path):
 
491
                continue
 
492
            if not self.work_tree.has_filename(path):
 
493
                deleted_paths.add(path)
 
494
                self.reporter.missing(path)
 
495
                deleted_ids.append(ie.file_id)
 
496
        self.work_tree.unversion(deleted_ids)
 
497
 
 
498
    def _populate_new_inv(self):
 
499
        """Build revision inventory.
 
500
 
 
501
        This creates a new empty inventory. Depending on
 
502
        which files are selected for commit, and what is present in the
 
503
        current tree, the new inventory is populated. inventory entries 
 
504
        which are candidates for modification have their revision set to
 
505
        None; inventory entries that are carried over untouched have their
 
506
        revision set to their prior value.
 
507
        """
 
508
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
509
        # results to create a new inventory at the same time, which results
 
510
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
511
        # ADHB 11-07-2006
 
512
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
513
        entries = self.work_inv.iter_entries()
 
514
        if not self.builder.record_root_entry:
 
515
            symbol_versioning.warn('CommitBuilders should support recording'
 
516
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
517
                stacklevel=1)
 
518
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
519
            entries.next()
 
520
            self._emit_progress_update()
 
521
        for path, new_ie in entries:
 
522
            self._emit_progress_update()
 
523
            file_id = new_ie.file_id
 
524
            # mutter('check %s {%s}', path, file_id)
 
525
            if (not self.specific_files or 
 
526
                is_inside_or_parent_of_any(self.specific_files, path)):
 
527
                    # mutter('%s selected for commit', path)
 
528
                    ie = new_ie.copy()
 
529
                    ie.revision = None
 
530
            else:
 
531
                # mutter('%s not selected for commit', path)
 
532
                if self.basis_inv.has_id(file_id):
 
533
                    ie = self.basis_inv[file_id].copy()
 
534
                else:
 
535
                    # this entry is new and not being committed
 
536
                    continue
 
537
 
 
538
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
539
                path, self.work_tree)
 
540
            # describe the nature of the change that has occurred relative to
 
541
            # the basis inventory.
 
542
            if (self.basis_inv.has_id(ie.file_id)):
 
543
                basis_ie = self.basis_inv[ie.file_id]
 
544
            else:
 
545
                basis_ie = None
 
546
            change = ie.describe_change(basis_ie, ie)
 
547
            if change in (InventoryEntry.RENAMED, 
 
548
                InventoryEntry.MODIFIED_AND_RENAMED):
 
549
                old_path = self.basis_inv.id2path(ie.file_id)
 
550
                self.reporter.renamed(change, old_path, path)
 
551
            else:
 
552
                self.reporter.snapshot_change(change, path)
 
553
 
 
554
        if not self.specific_files:
 
555
            return
 
556
 
 
557
        # ignore removals that don't match filespec
 
558
        for path, new_ie in self.basis_inv.iter_entries():
 
559
            if new_ie.file_id in self.work_inv:
 
560
                continue
 
561
            if is_inside_any(self.specific_files, path):
 
562
                continue
 
563
            ie = new_ie.copy()
 
564
            ie.revision = None
 
565
            self.builder.record_entry_contents(ie, self.parent_invs, path,
 
566
                                               self.basis_tree)
 
567
 
 
568
    def _emit_progress_update(self):
 
569
        """Emit an update to the progress bar."""
 
570
        self.pb.update("Committing", self.pb_count, self.pb_total)
 
571
        self.pb_count += 1
 
572
 
 
573
    def _report_deletes(self):
 
574
        for path, ie in self.basis_inv.iter_entries():
 
575
            if ie.file_id not in self.builder.new_inventory:
 
576
                self.reporter.deleted(path)
 
577
 
 
578