/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: Aaron Bentley
  • Date: 2007-02-09 15:56:49 UTC
  • mto: This revision was merged to the branch mainline in revision 2288.
  • Revision ID: abentley@panoramicfeedback.com-20070209155649-qxg6cqptrwyd4xof
Apply change reporting to merge

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.
 
18
# The newly committed revision is going to have a shape corresponding
 
19
# to that of the working inventory.  Files that are not in the
 
20
# working tree and that were in the predecessor are reported as
 
21
# removed --- this can include files that were either removed from the
 
22
# inventory or deleted in the working tree.  If they were only
 
23
# deleted from disk, they are removed from the working inventory.
 
24
 
 
25
# We then consider the remaining entries, which will be in the new
 
26
# version.  Directory entries are simply copied across.  File entries
 
27
# must be checked to see if a new version of the file should be
 
28
# recorded.  For each parent revision inventory, we check to see what
 
29
# version of the file was present.  If the file was present in at
 
30
# least one tree, and if it was the same version in all the trees,
 
31
# then we can just refer to that version.  Otherwise, a new version
 
32
# representing the merger of the file versions must be added.
 
33
 
 
34
# TODO: Update hashcache before and after - or does the WorkingTree
 
35
# look after that?
 
36
 
 
37
# TODO: Rather than mashing together the ancestry and storing it back,
 
38
# perhaps the weave should have single method which does it all in one
 
39
# go, avoiding a lot of redundant work.
 
40
 
 
41
# TODO: Perhaps give a warning if one of the revisions marked as
 
42
# merged is already in the ancestry, and then don't record it as a
 
43
# distinct parent.
 
44
 
 
45
# TODO: If the file is newly merged but unchanged from the version it
 
46
# merges from, then it should still be reported as newly added
 
47
# relative to the basis revision.
 
48
 
 
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
 
50
# the rest of the code; add a deprecation of the old name.
 
51
 
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
 
59
from bzrlib import (
 
60
    errors,
 
61
    inventory,
 
62
    tree,
 
63
    )
 
64
import bzrlib.config
 
65
from bzrlib.errors import (BzrError, PointlessCommit,
 
66
                           ConflictsInTree,
 
67
                           StrictCommitFailed
 
68
                           )
 
69
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
70
                            is_inside_or_parent_of_any,
 
71
                            quotefn, sha_file, split_lines)
 
72
from bzrlib.testament import Testament
 
73
from bzrlib.trace import mutter, note, warning
 
74
from bzrlib.xml5 import serializer_v5
 
75
from bzrlib.inventory import Inventory, InventoryEntry
 
76
from bzrlib import symbol_versioning
 
77
from bzrlib.symbol_versioning import (deprecated_passed,
 
78
        deprecated_function,
 
79
        DEPRECATED_PARAMETER)
 
80
from bzrlib.workingtree import WorkingTree
 
81
import bzrlib.ui
 
82
 
 
83
 
 
84
class NullCommitReporter(object):
 
85
    """I report on progress of a commit."""
 
86
 
 
87
    def snapshot_change(self, change, path):
 
88
        pass
 
89
 
 
90
    def completed(self, revno, rev_id):
 
91
        pass
 
92
 
 
93
    def deleted(self, file_id):
 
94
        pass
 
95
 
 
96
    def escaped(self, escape_count, message):
 
97
        pass
 
98
 
 
99
    def missing(self, path):
 
100
        pass
 
101
 
 
102
    def renamed(self, change, old_path, new_path):
 
103
        pass
 
104
 
 
105
 
 
106
class ReportCommitToLog(NullCommitReporter):
 
107
 
 
108
    # this may be more useful if 'note' was replaced by an overridable
 
109
    # method on self, which would allow more trivial subclassing.
 
110
    # alternative, a callable could be passed in, allowing really trivial
 
111
    # reuse for some uis. RBC 20060511
 
112
 
 
113
    def snapshot_change(self, change, path):
 
114
        if change == 'unchanged':
 
115
            return
 
116
        if change == 'added' and path == '':
 
117
            return
 
118
        note("%s %s", change, path)
 
119
 
 
120
    def completed(self, revno, rev_id):
 
121
        note('Committed revision %d.', revno)
 
122
    
 
123
    def deleted(self, file_id):
 
124
        note('deleted %s', file_id)
 
125
 
 
126
    def escaped(self, escape_count, message):
 
127
        note("replaced %d control characters in message", escape_count)
 
128
 
 
129
    def missing(self, path):
 
130
        note('missing %s', path)
 
131
 
 
132
    def renamed(self, change, old_path, new_path):
 
133
        note('%s %s => %s', change, old_path, new_path)
 
134
 
 
135
 
 
136
class Commit(object):
 
137
    """Task of committing a new revision.
 
138
 
 
139
    This is a MethodObject: it accumulates state as the commit is
 
140
    prepared, and then it is discarded.  It doesn't represent
 
141
    historical revisions, just the act of recording a new one.
 
142
 
 
143
            missing_ids
 
144
            Modified to hold a list of files that have been deleted from
 
145
            the working directory; these should be removed from the
 
146
            working inventory.
60
147
    """
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):
 
148
    def __init__(self,
 
149
                 reporter=None,
 
150
                 config=None):
 
151
        if reporter is not None:
 
152
            self.reporter = reporter
 
153
        else:
 
154
            self.reporter = NullCommitReporter()
 
155
        if config is not None:
 
156
            self.config = config
 
157
        else:
 
158
            self.config = None
 
159
        
 
160
    def commit(self,
 
161
               branch=DEPRECATED_PARAMETER, message=None,
 
162
               timestamp=None,
 
163
               timezone=None,
 
164
               committer=None,
 
165
               specific_files=None,
 
166
               rev_id=None,
 
167
               allow_pointless=True,
 
168
               strict=False,
 
169
               verbose=False,
 
170
               revprops=None,
 
171
               working_tree=None,
 
172
               local=False,
 
173
               reporter=None,
 
174
               config=None,
 
175
               message_callback=None):
 
176
        """Commit working copy as a new revision.
 
177
 
 
178
        branch -- the deprecated branch to commit to. New callers should pass in 
 
179
                  working_tree instead
 
180
 
 
181
        message -- the commit message (it or message_callback is required)
 
182
 
 
183
        timestamp -- if not None, seconds-since-epoch for a
 
184
             postdated/predated commit.
 
185
 
 
186
        specific_files -- If true, commit only those files.
 
187
 
 
188
        rev_id -- If set, use this as the new revision id.
 
189
            Useful for test or import commands that need to tightly
 
190
            control what revisions are assigned.  If you duplicate
 
191
            a revision id that exists elsewhere it is your own fault.
 
192
            If null (default), a time/random revision id is generated.
 
193
 
 
194
        allow_pointless -- If true (default), commit even if nothing
 
195
            has changed and no merges are recorded.
 
196
 
 
197
        strict -- If true, don't allow a commit if the working tree
 
198
            contains unknown files.
 
199
 
 
200
        revprops -- Properties for new revision
 
201
        :param local: Perform a local only commit.
 
202
        """
 
203
        mutter('preparing to commit')
 
204
 
 
205
        if deprecated_passed(branch):
 
206
            symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
 
207
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
 
208
                 DeprecationWarning, stacklevel=2)
 
209
            self.branch = branch
 
210
            self.work_tree = self.branch.bzrdir.open_workingtree()
 
211
        elif working_tree is None:
 
212
            raise BzrError("One of branch and working_tree must be passed into commit().")
 
213
        else:
 
214
            self.work_tree = working_tree
 
215
            self.branch = self.work_tree.branch
 
216
        if message_callback is None:
 
217
            if message is not None:
 
218
                if isinstance(message, str):
 
219
                    message = message.decode(bzrlib.user_encoding)
 
220
                message_callback = lambda x: message
 
221
            else:
 
222
                raise BzrError("The message or message_callback keyword"
 
223
                               " parameter is required for commit().")
 
224
 
 
225
        self.bound_branch = None
 
226
        self.local = local
 
227
        self.master_branch = None
 
228
        self.master_locked = False
 
229
        self.rev_id = None
 
230
        self.specific_files = specific_files
 
231
        self.allow_pointless = allow_pointless
 
232
 
 
233
        if reporter is None and self.reporter is None:
 
234
            self.reporter = NullCommitReporter()
 
235
        elif reporter is not None:
 
236
            self.reporter = reporter
 
237
 
 
238
        self.work_tree.lock_write()
 
239
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
240
        try:
 
241
            # Cannot commit with conflicts present.
 
242
            if len(self.work_tree.conflicts())>0:
 
243
                raise ConflictsInTree
 
244
 
 
245
            # setup the bound branch variables as needed.
 
246
            self._check_bound_branch()
 
247
 
 
248
            # check for out of date working trees
 
249
            try:
 
250
                first_tree_parent = self.work_tree.get_parent_ids()[0]
 
251
            except IndexError:
 
252
                # if there are no parents, treat our parent as 'None'
 
253
                # this is so that we still consier the master branch
 
254
                # - in a checkout scenario the tree may have no
 
255
                # parents but the branch may do.
 
256
                first_tree_parent = None
 
257
            master_last = self.master_branch.last_revision()
 
258
            if (master_last is not None and
 
259
                master_last != first_tree_parent):
 
260
                raise errors.OutOfDateTree(self.work_tree)
 
261
    
 
262
            if strict:
 
263
                # raise an exception as soon as we find a single unknown.
 
264
                for unknown in self.work_tree.unknowns():
 
265
                    raise StrictCommitFailed()
 
266
                   
 
267
            if self.config is None:
 
268
                self.config = self.branch.get_config()
 
269
 
 
270
            self.work_inv = self.work_tree.inventory
 
271
            self.basis_tree = self.work_tree.basis_tree()
 
272
            self.basis_inv = self.basis_tree.inventory
 
273
            if specific_files is not None:
 
274
                # Ensure specified files are versioned
 
275
                # (We don't actually need the ids here)
 
276
                tree.find_ids_across_trees(specific_files, 
 
277
                                           [self.basis_tree, self.work_tree])
 
278
            # one to finish, one for rev and inventory, and one for each
 
279
            # inventory entry, and the same for the new inventory.
 
280
            # note that this estimate is too long when we do a partial tree
 
281
            # commit which excludes some new files from being considered.
 
282
            # The estimate is corrected when we populate the new inv.
 
283
            self.pb_total = len(self.work_inv) + 5
 
284
            self.pb_count = 0
 
285
 
 
286
            self._gather_parents()
 
287
            if len(self.parents) > 1 and self.specific_files:
 
288
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
 
289
                        self.specific_files)
 
290
            
 
291
            self.builder = self.branch.get_commit_builder(self.parents, 
 
292
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
293
            
 
294
            self._remove_deleted()
 
295
            self._populate_new_inv()
 
296
            self._report_deletes()
 
297
 
 
298
            self._check_pointless()
 
299
 
 
300
            self._emit_progress_update()
 
301
            # TODO: Now the new inventory is known, check for conflicts and
 
302
            # prompt the user for a commit message.
 
303
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
304
            # weave lines, because nothing should be recorded until it is known
 
305
            # that commit will succeed.
 
306
            self.builder.finish_inventory()
 
307
            self._emit_progress_update()
 
308
            message = message_callback(self)
 
309
            assert isinstance(message, unicode), type(message)
 
310
            self.message = message
 
311
            self._escape_commit_message()
 
312
 
 
313
            self.rev_id = self.builder.commit(self.message)
 
314
            self._emit_progress_update()
 
315
            # revision data is in the local branch now.
 
316
            
 
317
            # upload revision data to the master.
 
318
            # this will propagate merged revisions too if needed.
 
319
            if self.bound_branch:
 
320
                self.master_branch.repository.fetch(self.branch.repository,
 
321
                                                    revision_id=self.rev_id)
 
322
                # now the master has the revision data
 
323
                # 'commit' to the master first so a timeout here causes the local
 
324
                # branch to be out of date
 
325
                self.master_branch.append_revision(self.rev_id)
 
326
 
 
327
            # and now do the commit locally.
 
328
            self.branch.append_revision(self.rev_id)
 
329
 
 
330
            rev_tree = self.builder.revision_tree()
 
331
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
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()
 
344
        finally:
 
345
            self._cleanup()
 
346
        return self.rev_id
 
347
 
 
348
    def _any_real_changes(self):
 
349
        """Are there real changes between new_inventory and basis?
 
350
 
 
351
        For trees without rich roots, inv.root.revision changes every commit.
 
352
        But if that is the only change, we want to treat it as though there
 
353
        are *no* changes.
 
354
        """
 
355
        new_entries = self.builder.new_inventory.iter_entries()
 
356
        basis_entries = self.basis_inv.iter_entries()
 
357
        new_path, new_root_ie = new_entries.next()
 
358
        basis_path, basis_root_ie = basis_entries.next()
 
359
 
 
360
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
361
        def ie_equal_no_revision(this, other):
 
362
            return ((this.file_id == other.file_id)
 
363
                    and (this.name == other.name)
 
364
                    and (this.symlink_target == other.symlink_target)
 
365
                    and (this.text_sha1 == other.text_sha1)
 
366
                    and (this.text_size == other.text_size)
 
367
                    and (this.text_id == other.text_id)
 
368
                    and (this.parent_id == other.parent_id)
 
369
                    and (this.kind == other.kind)
 
370
                    and (this.executable == other.executable)
 
371
                    )
 
372
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
373
            return True
 
374
 
 
375
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
376
            if new_ie != basis_ie:
 
377
                return True
 
378
 
 
379
        # No actual changes present
 
380
        return False
 
381
 
 
382
    def _check_pointless(self):
 
383
        if self.allow_pointless:
 
384
            return
 
385
        # A merge with no effect on files
 
386
        if len(self.parents) > 1:
 
387
            return
 
388
        # work around the fact that a newly-initted tree does differ from its
 
389
        # basis
 
390
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
101
391
            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())
 
392
        # Shortcut, if the number of entries changes, then we obviously have
 
393
        # a change
 
394
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
395
            return
 
396
        # If length == 1, then we only have the root entry. Which means
 
397
        # that there is no real difference (only the root could be different)
 
398
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
 
399
            return
 
400
        raise PointlessCommit()
 
401
 
 
402
    def _check_bound_branch(self):
 
403
        """Check to see if the local branch is bound.
 
404
 
 
405
        If it is bound, then most of the commit will actually be
 
406
        done using the remote branch as the target branch.
 
407
        Only at the end will the local branch be updated.
 
408
        """
 
409
        if self.local and not self.branch.get_bound_location():
 
410
            raise errors.LocalRequiresBoundBranch()
 
411
 
 
412
        if not self.local:
 
413
            self.master_branch = self.branch.get_master_branch()
 
414
 
 
415
        if not self.master_branch:
 
416
            # make this branch the reference branch for out of date checks.
 
417
            self.master_branch = self.branch
 
418
            return
 
419
 
 
420
        # If the master branch is bound, we must fail
 
421
        master_bound_location = self.master_branch.get_bound_location()
 
422
        if master_bound_location:
 
423
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
424
                    self.master_branch, master_bound_location)
 
425
 
 
426
        # TODO: jam 20051230 We could automatically push local
 
427
        #       commits to the remote branch if they would fit.
 
428
        #       But for now, just require remote to be identical
 
429
        #       to local.
 
430
        
 
431
        # Make sure the local branch is identical to the master
 
432
        master_info = self.master_branch.last_revision_info()
 
433
        local_info = self.branch.last_revision_info()
 
434
        if local_info != master_info:
 
435
            raise errors.BoundBranchOutOfDate(self.branch,
 
436
                    self.master_branch)
 
437
 
 
438
        # Now things are ready to change the master branch
 
439
        # so grab the lock
 
440
        self.bound_branch = self.branch
 
441
        self.master_branch.lock_write()
 
442
        self.master_locked = True
 
443
 
 
444
    def _cleanup(self):
 
445
        """Cleanup any open locks, progress bars etc."""
 
446
        cleanups = [self._cleanup_bound_branch,
 
447
                    self.work_tree.unlock,
 
448
                    self.pb.finished]
 
449
        found_exception = None
 
450
        for cleanup in cleanups:
 
451
            try:
 
452
                cleanup()
 
453
            # we want every cleanup to run no matter what.
 
454
            # so we have a catchall here, but we will raise the
 
455
            # last encountered exception up the stack: and
 
456
            # typically this will be useful enough.
 
457
            except Exception, e:
 
458
                found_exception = e
 
459
        if found_exception is not None: 
 
460
            # don't do a plan raise, because the last exception may have been
 
461
            # trashed, e is our sure-to-work exception even though it loses the
 
462
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
463
            # exc_info and if its the same one do a plain raise otherwise 
 
464
            # 'raise e' as we do now.
 
465
            raise e
 
466
 
 
467
    def _cleanup_bound_branch(self):
 
468
        """Executed at the end of a try/finally to cleanup a bound branch.
 
469
 
 
470
        If the branch wasn't bound, this is a no-op.
 
471
        If it was, it resents self.branch to the local branch, instead
 
472
        of being the master.
 
473
        """
 
474
        if not self.bound_branch:
 
475
            return
 
476
        if self.master_locked:
 
477
            self.master_branch.unlock()
 
478
 
 
479
    def _escape_commit_message(self):
 
480
        """Replace xml-incompatible control characters."""
 
481
        # FIXME: RBC 20060419 this should be done by the revision
 
482
        # serialiser not by commit. Then we can also add an unescaper
 
483
        # in the deserializer and start roundtripping revision messages
 
484
        # precisely. See repository_implementations/test_repository.py
 
485
        
 
486
        # Python strings can include characters that can't be
 
487
        # represented in well-formed XML; escape characters that
 
488
        # aren't listed in the XML specification
 
489
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
490
        self.message, escape_count = re.subn(
 
491
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
492
            lambda match: match.group(0).encode('unicode_escape'),
 
493
            self.message)
 
494
        if escape_count:
 
495
            self.reporter.escaped(escape_count, self.message)
 
496
 
 
497
    def _gather_parents(self):
 
498
        """Record the parents of a merge for merge detection."""
 
499
        # TODO: Make sure that this list doesn't contain duplicate 
 
500
        # entries and the order is preserved when doing this.
 
501
        self.parents = self.work_tree.get_parent_ids()
 
502
        self.parent_invs = []
 
503
        for revision in self.parents:
 
504
            if self.branch.repository.has_revision(revision):
 
505
                mutter('commit parent revision {%s}', revision)
 
506
                inventory = self.branch.repository.get_inventory(revision)
 
507
                self.parent_invs.append(inventory)
239
508
            else:
240
 
                # omit this from committed inventory
 
509
                mutter('commit parent ghost revision {%s}', revision)
 
510
 
 
511
    def _remove_deleted(self):
 
512
        """Remove deleted files from the working inventories.
 
513
 
 
514
        This is done prior to taking the working inventory as the
 
515
        basis for the new committed inventory.
 
516
 
 
517
        This returns true if any files
 
518
        *that existed in the basis inventory* were deleted.
 
519
        Files that were added and deleted
 
520
        in the working copy don't matter.
 
521
        """
 
522
        specific = self.specific_files
 
523
        deleted_ids = []
 
524
        deleted_paths = set()
 
525
        for path, ie in self.work_inv.iter_entries():
 
526
            if is_inside_any(deleted_paths, path):
 
527
                # The tree will delete the required ids recursively.
 
528
                continue
 
529
            if specific and not is_inside_any(specific, path):
 
530
                continue
 
531
            if not self.work_tree.has_filename(path):
 
532
                deleted_paths.add(path)
 
533
                self.reporter.missing(path)
 
534
                deleted_ids.append(ie.file_id)
 
535
        self.work_tree.unversion(deleted_ids)
 
536
 
 
537
    def _populate_new_inv(self):
 
538
        """Build revision inventory.
 
539
 
 
540
        This creates a new empty inventory. Depending on
 
541
        which files are selected for commit, and what is present in the
 
542
        current tree, the new inventory is populated. inventory entries 
 
543
        which are candidates for modification have their revision set to
 
544
        None; inventory entries that are carried over untouched have their
 
545
        revision set to their prior value.
 
546
        """
 
547
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
548
        # results to create a new inventory at the same time, which results
 
549
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
550
        # ADHB 11-07-2006
 
551
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
552
        assert self.work_inv.root is not None
 
553
        entries = self.work_inv.iter_entries()
 
554
        if not self.builder.record_root_entry:
 
555
            symbol_versioning.warn('CommitBuilders should support recording'
 
556
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
557
                stacklevel=1)
 
558
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
559
            entries.next()
 
560
            self._emit_progress_update()
 
561
        for path, new_ie in entries:
 
562
            self._emit_progress_update()
 
563
            file_id = new_ie.file_id
 
564
            try:
 
565
                kind = self.work_tree.kind(file_id)
 
566
                if kind != new_ie.kind:
 
567
                    new_ie = inventory.make_entry(kind, new_ie.name,
 
568
                                                  new_ie.parent_id, file_id)
 
569
            except errors.NoSuchFile:
241
570
                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
 
571
            # mutter('check %s {%s}', path, file_id)
 
572
            if (not self.specific_files or 
 
573
                is_inside_or_parent_of_any(self.specific_files, path)):
 
574
                    # mutter('%s selected for commit', path)
 
575
                    ie = new_ie.copy()
 
576
                    ie.revision = None
 
577
            else:
 
578
                # mutter('%s not selected for commit', path)
 
579
                if self.basis_inv.has_id(file_id):
 
580
                    ie = self.basis_inv[file_id].copy()
 
581
                else:
 
582
                    # this entry is new and not being committed
 
583
                    continue
 
584
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
585
                path, self.work_tree)
 
586
            # describe the nature of the change that has occurred relative to
 
587
            # the basis inventory.
 
588
            if (self.basis_inv.has_id(ie.file_id)):
 
589
                basis_ie = self.basis_inv[ie.file_id]
 
590
            else:
 
591
                basis_ie = None
 
592
            change = ie.describe_change(basis_ie, ie)
 
593
            if change in (InventoryEntry.RENAMED, 
 
594
                InventoryEntry.MODIFIED_AND_RENAMED):
 
595
                old_path = self.basis_inv.id2path(ie.file_id)
 
596
                self.reporter.renamed(change, old_path, path)
 
597
            else:
 
598
                self.reporter.snapshot_change(change, path)
 
599
 
 
600
        if not self.specific_files:
 
601
            return
 
602
 
 
603
        # ignore removals that don't match filespec
 
604
        for path, new_ie in self.basis_inv.iter_entries():
 
605
            if new_ie.file_id in self.work_inv:
 
606
                continue
 
607
            if is_inside_any(self.specific_files, path):
 
608
                continue
 
609
            ie = new_ie.copy()
 
610
            ie.revision = None
 
611
            self.builder.record_entry_contents(ie, self.parent_invs, path,
 
612
                                               self.basis_tree)
 
613
 
 
614
    def _emit_progress_update(self):
 
615
        """Emit an update to the progress bar."""
 
616
        self.pb.update("Committing", self.pb_count, self.pb_total)
 
617
        self.pb_count += 1
 
618
 
 
619
    def _report_deletes(self):
 
620
        for path, ie in self.basis_inv.iter_entries():
 
621
            if ie.file_id not in self.builder.new_inventory:
 
622
                self.reporter.deleted(path)
311
623
 
312
624