/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: John Arbash Meinel
  • Date: 2006-09-23 19:05:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2036.
  • Revision ID: john@arbash-meinel.com-20060923190544-c3f625a5bc5589ab
paths are always forward slashed for python zipfiles

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