/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: Martin Pool
  • Date: 2007-06-15 07:01:24 UTC
  • mfrom: (2528 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2530.
  • Revision ID: mbp@sourcefrog.net-20070615070124-clpwqh5gxc4wbf9l
Merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007 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
from bzrlib.branch import Branch
 
65
import bzrlib.config
 
66
from bzrlib.errors import (BzrError, PointlessCommit,
 
67
                           ConflictsInTree,
 
68
                           StrictCommitFailed
 
69
                           )
 
70
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
71
                            is_inside_or_parent_of_any,
 
72
                            quotefn, sha_file, split_lines)
 
73
from bzrlib.testament import Testament
 
74
from bzrlib.trace import mutter, note, warning
 
75
from bzrlib.xml5 import serializer_v5
 
76
from bzrlib.inventory import Inventory, InventoryEntry
 
77
from bzrlib import symbol_versioning
 
78
from bzrlib.symbol_versioning import (deprecated_passed,
 
79
        deprecated_function,
 
80
        DEPRECATED_PARAMETER)
 
81
from bzrlib.workingtree import WorkingTree
 
82
import bzrlib.ui
 
83
 
 
84
 
 
85
class NullCommitReporter(object):
 
86
    """I report on progress of a commit."""
 
87
 
 
88
    def snapshot_change(self, change, path):
 
89
        pass
 
90
 
 
91
    def completed(self, revno, rev_id):
 
92
        pass
 
93
 
 
94
    def deleted(self, file_id):
 
95
        pass
 
96
 
 
97
    def escaped(self, escape_count, message):
 
98
        pass
 
99
 
 
100
    def missing(self, path):
 
101
        pass
 
102
 
 
103
    def renamed(self, change, old_path, new_path):
 
104
        pass
 
105
 
 
106
 
 
107
class ReportCommitToLog(NullCommitReporter):
 
108
 
 
109
    def _note(self, format, *args):
 
110
        """Output a message.
 
111
 
 
112
        Messages are output by writing directly to stderr instead of
 
113
        using bzrlib.trace.note(). The latter constantly updates the
 
114
        log file as we go causing an unnecessary performance hit.
 
115
 
 
116
        Subclasses may choose to override this method but need to be aware
 
117
        of its potential impact on performance.
 
118
        """
 
119
        bzrlib.ui.ui_factory.clear_term()
 
120
        sys.stderr.write((format + "\n") % args)
 
121
 
 
122
    def snapshot_change(self, change, path):
 
123
        if change == 'unchanged':
 
124
            return
 
125
        if change == 'added' and path == '':
 
126
            return
 
127
        self._note("%s %s", change, path)
 
128
 
 
129
    def completed(self, revno, rev_id):
 
130
        self._note('Committed revision %d.', revno)
 
131
    
 
132
    def deleted(self, file_id):
 
133
        self._note('deleted %s', file_id)
 
134
 
 
135
    def escaped(self, escape_count, message):
 
136
        self._note("replaced %d control characters in message", escape_count)
 
137
 
 
138
    def missing(self, path):
 
139
        self._note('missing %s', path)
 
140
 
 
141
    def renamed(self, change, old_path, new_path):
 
142
        self._note('%s %s => %s', change, old_path, new_path)
 
143
 
 
144
 
 
145
class Commit(object):
 
146
    """Task of committing a new revision.
 
147
 
 
148
    This is a MethodObject: it accumulates state as the commit is
 
149
    prepared, and then it is discarded.  It doesn't represent
 
150
    historical revisions, just the act of recording a new one.
 
151
 
 
152
            missing_ids
 
153
            Modified to hold a list of files that have been deleted from
 
154
            the working directory; these should be removed from the
 
155
            working inventory.
60
156
    """
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):
 
157
    def __init__(self,
 
158
                 reporter=None,
 
159
                 config=None):
 
160
        if reporter is not None:
 
161
            self.reporter = reporter
 
162
        else:
 
163
            self.reporter = NullCommitReporter()
 
164
        self.config = config
 
165
        
 
166
    def commit(self,
 
167
               message=None,
 
168
               timestamp=None,
 
169
               timezone=None,
 
170
               committer=None,
 
171
               specific_files=None,
 
172
               rev_id=None,
 
173
               allow_pointless=True,
 
174
               strict=False,
 
175
               verbose=False,
 
176
               revprops=None,
 
177
               working_tree=None,
 
178
               local=False,
 
179
               reporter=None,
 
180
               config=None,
 
181
               message_callback=None,
 
182
               recursive='down'):
 
183
        """Commit working copy as a new revision.
 
184
 
 
185
        :param message: the commit message (it or message_callback is required)
 
186
 
 
187
        :param timestamp: if not None, seconds-since-epoch for a
 
188
            postdated/predated commit.
 
189
 
 
190
        :param specific_files: If true, commit only those files.
 
191
 
 
192
        :param rev_id: If set, use this as the new revision id.
 
193
            Useful for test or import commands that need to tightly
 
194
            control what revisions are assigned.  If you duplicate
 
195
            a revision id that exists elsewhere it is your own fault.
 
196
            If null (default), a time/random revision id is generated.
 
197
 
 
198
        :param allow_pointless: If true (default), commit even if nothing
 
199
            has changed and no merges are recorded.
 
200
 
 
201
        :param strict: If true, don't allow a commit if the working tree
 
202
            contains unknown files.
 
203
 
 
204
        :param revprops: Properties for new revision
 
205
        :param local: Perform a local only commit.
 
206
        :param recursive: If set to 'down', commit in any subtrees that have
 
207
            pending changes of any sort during this commit.
 
208
        """
 
209
        mutter('preparing to commit')
 
210
 
 
211
        if working_tree is None:
 
212
            raise BzrError("working_tree must be passed into commit().")
 
213
        else:
 
214
            self.work_tree = working_tree
 
215
            self.branch = self.work_tree.branch
 
216
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
217
                if not self.branch.repository.supports_rich_root():
 
218
                    raise errors.RootNotRich()
 
219
        if message_callback is None:
 
220
            if message is not None:
 
221
                if isinstance(message, str):
 
222
                    message = message.decode(bzrlib.user_encoding)
 
223
                message_callback = lambda x: message
 
224
            else:
 
225
                raise BzrError("The message or message_callback keyword"
 
226
                               " parameter is required for commit().")
 
227
 
 
228
        self.bound_branch = None
 
229
        self.local = local
 
230
        self.master_branch = None
 
231
        self.master_locked = False
 
232
        self.rev_id = None
 
233
        self.specific_files = specific_files
 
234
        self.allow_pointless = allow_pointless
 
235
        self.recursive = recursive
 
236
        self.revprops = revprops
 
237
        self.message_callback = message_callback
 
238
        self.timestamp = timestamp
 
239
        self.timezone = timezone
 
240
        self.committer = committer
 
241
        self.strict = strict
 
242
        self.verbose = verbose
 
243
 
 
244
        if reporter is None and self.reporter is None:
 
245
            self.reporter = NullCommitReporter()
 
246
        elif reporter is not None:
 
247
            self.reporter = reporter
 
248
 
 
249
        self.work_tree.lock_write()
 
250
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
251
        self.basis_tree = self.work_tree.basis_tree()
 
252
        self.basis_tree.lock_read()
 
253
        try:
 
254
            # Cannot commit with conflicts present.
 
255
            if len(self.work_tree.conflicts()) > 0:
 
256
                raise ConflictsInTree
 
257
 
 
258
            # Setup the bound branch variables as needed.
 
259
            self._check_bound_branch()
 
260
 
 
261
            # Check that the working tree is up to date
 
262
            old_revno,new_revno = self._check_out_of_date_tree()
 
263
 
 
264
            if strict:
 
265
                # raise an exception as soon as we find a single unknown.
 
266
                for unknown in self.work_tree.unknowns():
 
267
                    raise StrictCommitFailed()
 
268
                   
 
269
            if self.config is None:
 
270
                self.config = self.branch.get_config()
 
271
 
 
272
            self.work_inv = self.work_tree.inventory
 
273
            self.basis_inv = self.basis_tree.inventory
 
274
            if specific_files is not None:
 
275
                # Ensure specified files are versioned
 
276
                # (We don't actually need the ids here)
 
277
                # XXX: Dont we have filter_unversioned to do this more
 
278
                # cheaply?
 
279
                tree.find_ids_across_trees(specific_files,
 
280
                                           [self.basis_tree, self.work_tree])
 
281
 
 
282
            # Setup the progress bar ...
 
283
            # one to finish, one for rev and inventory, and one for each
 
284
            # inventory entry, and the same for the new inventory.
 
285
            # note that this estimate is too long when we do a partial tree
 
286
            # commit which excludes some new files from being considered.
 
287
            # The estimate is corrected when we populate the new inv.
 
288
            self.pb_total = len(self.work_inv) + 5
 
289
            self.pb_count = 0
 
290
 
 
291
            self._gather_parents()
 
292
            if len(self.parents) > 1 and self.specific_files:
 
293
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
294
            
 
295
            # Build the new inventory
 
296
            self.builder = self.branch.get_commit_builder(self.parents,
 
297
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
298
            self._remove_deleted()
 
299
            self._populate_new_inv()
 
300
            self._report_deletes()
 
301
            self._check_pointless()
 
302
            self._emit_progress_update()
 
303
 
 
304
            # TODO: Now the new inventory is known, check for conflicts and
 
305
            # prompt the user for a commit message.
 
306
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
307
            # weave lines, because nothing should be recorded until it is known
 
308
            # that commit will succeed.
 
309
            self.builder.finish_inventory()
 
310
            self._emit_progress_update()
 
311
            message = message_callback(self)
 
312
            assert isinstance(message, unicode), type(message)
 
313
            self.message = message
 
314
            self._escape_commit_message()
 
315
 
 
316
            # Add revision data to the local branch
 
317
            self.rev_id = self.builder.commit(self.message)
 
318
            self._emit_progress_update()
 
319
            
 
320
            # upload revision data to the master.
 
321
            # this will propagate merged revisions too if needed.
 
322
            if self.bound_branch:
 
323
                self.master_branch.repository.fetch(self.branch.repository,
 
324
                                                    revision_id=self.rev_id)
 
325
                # now the master has the revision data
 
326
                # 'commit' to the master first so a timeout here causes the
 
327
                # local branch to be out of date
 
328
                self.master_branch.set_last_revision_info(new_revno,
 
329
                                                          self.rev_id)
 
330
 
 
331
            # and now do the commit locally.
 
332
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
333
 
 
334
            # Make the working tree up to date with the branch
 
335
            rev_tree = self.builder.revision_tree()
 
336
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
337
            self.reporter.completed(new_revno, self.rev_id)
 
338
 
 
339
            # Process the post commit hooks, if any
 
340
            self._process_hooks(old_revno, new_revno)
 
341
            self._emit_progress_update()
 
342
        finally:
 
343
            self._cleanup()
 
344
        return self.rev_id
 
345
 
 
346
    def _any_real_changes(self):
 
347
        """Are there real changes between new_inventory and basis?
 
348
 
 
349
        For trees without rich roots, inv.root.revision changes every commit.
 
350
        But if that is the only change, we want to treat it as though there
 
351
        are *no* changes.
 
352
        """
 
353
        new_entries = self.builder.new_inventory.iter_entries()
 
354
        basis_entries = self.basis_inv.iter_entries()
 
355
        new_path, new_root_ie = new_entries.next()
 
356
        basis_path, basis_root_ie = basis_entries.next()
 
357
 
 
358
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
359
        def ie_equal_no_revision(this, other):
 
360
            return ((this.file_id == other.file_id)
 
361
                    and (this.name == other.name)
 
362
                    and (this.symlink_target == other.symlink_target)
 
363
                    and (this.text_sha1 == other.text_sha1)
 
364
                    and (this.text_size == other.text_size)
 
365
                    and (this.text_id == other.text_id)
 
366
                    and (this.parent_id == other.parent_id)
 
367
                    and (this.kind == other.kind)
 
368
                    and (this.executable == other.executable)
 
369
                    and (this.reference_revision == other.reference_revision)
 
370
                    )
 
371
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
372
            return True
 
373
 
 
374
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
375
            if new_ie != basis_ie:
 
376
                return True
 
377
 
 
378
        # No actual changes present
 
379
        return False
 
380
 
 
381
    def _check_pointless(self):
 
382
        if self.allow_pointless:
 
383
            return
 
384
        # A merge with no effect on files
 
385
        if len(self.parents) > 1:
 
386
            return
 
387
        # work around the fact that a newly-initted tree does differ from its
 
388
        # basis
 
389
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
101
390
            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())
 
391
        # Shortcut, if the number of entries changes, then we obviously have
 
392
        # a change
 
393
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
394
            return
 
395
        # If length == 1, then we only have the root entry. Which means
 
396
        # that there is no real difference (only the root could be different)
 
397
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
 
398
            return
 
399
        raise PointlessCommit()
 
400
 
 
401
    def _check_bound_branch(self):
 
402
        """Check to see if the local branch is bound.
 
403
 
 
404
        If it is bound, then most of the commit will actually be
 
405
        done using the remote branch as the target branch.
 
406
        Only at the end will the local branch be updated.
 
407
        """
 
408
        if self.local and not self.branch.get_bound_location():
 
409
            raise errors.LocalRequiresBoundBranch()
 
410
 
 
411
        if not self.local:
 
412
            self.master_branch = self.branch.get_master_branch()
 
413
 
 
414
        if not self.master_branch:
 
415
            # make this branch the reference branch for out of date checks.
 
416
            self.master_branch = self.branch
 
417
            return
 
418
 
 
419
        # If the master branch is bound, we must fail
 
420
        master_bound_location = self.master_branch.get_bound_location()
 
421
        if master_bound_location:
 
422
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
423
                    self.master_branch, master_bound_location)
 
424
 
 
425
        # TODO: jam 20051230 We could automatically push local
 
426
        #       commits to the remote branch if they would fit.
 
427
        #       But for now, just require remote to be identical
 
428
        #       to local.
 
429
        
 
430
        # Make sure the local branch is identical to the master
 
431
        master_info = self.master_branch.last_revision_info()
 
432
        local_info = self.branch.last_revision_info()
 
433
        if local_info != master_info:
 
434
            raise errors.BoundBranchOutOfDate(self.branch,
 
435
                    self.master_branch)
 
436
 
 
437
        # Now things are ready to change the master branch
 
438
        # so grab the lock
 
439
        self.bound_branch = self.branch
 
440
        self.master_branch.lock_write()
 
441
        self.master_locked = True
 
442
 
 
443
    def _check_out_of_date_tree(self):
 
444
        """Check that the working tree is up to date.
 
445
 
 
446
        :return: old_revision_number,new_revision_number tuple
 
447
        """
 
448
        try:
 
449
            first_tree_parent = self.work_tree.get_parent_ids()[0]
 
450
        except IndexError:
 
451
            # if there are no parents, treat our parent as 'None'
 
452
            # this is so that we still consider the master branch
 
453
            # - in a checkout scenario the tree may have no
 
454
            # parents but the branch may do.
 
455
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
456
        old_revno, master_last = self.master_branch.last_revision_info()
 
457
        if master_last != first_tree_parent:
 
458
            if master_last != bzrlib.revision.NULL_REVISION:
 
459
                raise errors.OutOfDateTree(self.work_tree)
 
460
        if self.branch.repository.has_revision(first_tree_parent):
 
461
            new_revno = old_revno + 1
 
462
        else:
 
463
            # ghost parents never appear in revision history.
 
464
            new_revno = 1
 
465
        return old_revno,new_revno
 
466
 
 
467
    def _process_hooks(self, old_revno, new_revno):
 
468
        """Process any registered commit hooks."""
 
469
        # old style commit hooks - should be deprecated ? (obsoleted in
 
470
        # 0.15)
 
471
        if self.config.post_commit() is not None:
 
472
            hooks = self.config.post_commit().split(' ')
 
473
            # this would be nicer with twisted.python.reflect.namedAny
 
474
            for hook in hooks:
 
475
                result = eval(hook + '(branch, rev_id)',
 
476
                              {'branch':self.branch,
 
477
                               'bzrlib':bzrlib,
 
478
                               'rev_id':self.rev_id})
 
479
        # new style commit hooks:
 
480
        if not self.bound_branch:
 
481
            hook_master = self.branch
 
482
            hook_local = None
 
483
        else:
 
484
            hook_master = self.master_branch
 
485
            hook_local = self.branch
 
486
        # With bound branches, when the master is behind the local branch,
 
487
        # the 'old_revno' and old_revid values here are incorrect.
 
488
        # XXX: FIXME ^. RBC 20060206
 
489
        if self.parents:
 
490
            old_revid = self.parents[0]
 
491
        else:
 
492
            old_revid = bzrlib.revision.NULL_REVISION
 
493
        for hook in Branch.hooks['post_commit']:
 
494
            hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
495
                self.rev_id)
 
496
 
 
497
    def _cleanup(self):
 
498
        """Cleanup any open locks, progress bars etc."""
 
499
        cleanups = [self._cleanup_bound_branch,
 
500
                    self.basis_tree.unlock,
 
501
                    self.work_tree.unlock,
 
502
                    self.pb.finished]
 
503
        found_exception = None
 
504
        for cleanup in cleanups:
 
505
            try:
 
506
                cleanup()
 
507
            # we want every cleanup to run no matter what.
 
508
            # so we have a catchall here, but we will raise the
 
509
            # last encountered exception up the stack: and
 
510
            # typically this will be useful enough.
 
511
            except Exception, e:
 
512
                found_exception = e
 
513
        if found_exception is not None: 
 
514
            # don't do a plan raise, because the last exception may have been
 
515
            # trashed, e is our sure-to-work exception even though it loses the
 
516
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
517
            # exc_info and if its the same one do a plain raise otherwise 
 
518
            # 'raise e' as we do now.
 
519
            raise e
 
520
 
 
521
    def _cleanup_bound_branch(self):
 
522
        """Executed at the end of a try/finally to cleanup a bound branch.
 
523
 
 
524
        If the branch wasn't bound, this is a no-op.
 
525
        If it was, it resents self.branch to the local branch, instead
 
526
        of being the master.
 
527
        """
 
528
        if not self.bound_branch:
 
529
            return
 
530
        if self.master_locked:
 
531
            self.master_branch.unlock()
 
532
 
 
533
    def _escape_commit_message(self):
 
534
        """Replace xml-incompatible control characters."""
 
535
        # FIXME: RBC 20060419 this should be done by the revision
 
536
        # serialiser not by commit. Then we can also add an unescaper
 
537
        # in the deserializer and start roundtripping revision messages
 
538
        # precisely. See repository_implementations/test_repository.py
 
539
        
 
540
        # Python strings can include characters that can't be
 
541
        # represented in well-formed XML; escape characters that
 
542
        # aren't listed in the XML specification
 
543
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
544
        self.message, escape_count = re.subn(
 
545
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
546
            lambda match: match.group(0).encode('unicode_escape'),
 
547
            self.message)
 
548
        if escape_count:
 
549
            self.reporter.escaped(escape_count, self.message)
 
550
 
 
551
    def _gather_parents(self):
 
552
        """Record the parents of a merge for merge detection."""
 
553
        # TODO: Make sure that this list doesn't contain duplicate 
 
554
        # entries and the order is preserved when doing this.
 
555
        self.parents = self.work_tree.get_parent_ids()
 
556
        self.parent_invs = [self.basis_inv]
 
557
        for revision in self.parents[1:]:
 
558
            if self.branch.repository.has_revision(revision):
 
559
                mutter('commit parent revision {%s}', revision)
 
560
                inventory = self.branch.repository.get_inventory(revision)
 
561
                self.parent_invs.append(inventory)
239
562
            else:
240
 
                # omit this from committed inventory
 
563
                mutter('commit parent ghost revision {%s}', revision)
 
564
 
 
565
    def _remove_deleted(self):
 
566
        """Remove deleted files from the working inventories.
 
567
 
 
568
        This is done prior to taking the working inventory as the
 
569
        basis for the new committed inventory.
 
570
 
 
571
        This returns true if any files
 
572
        *that existed in the basis inventory* were deleted.
 
573
        Files that were added and deleted
 
574
        in the working copy don't matter.
 
575
        """
 
576
        specific = self.specific_files
 
577
        deleted_ids = []
 
578
        deleted_paths = set()
 
579
        for path, ie in self.work_inv.iter_entries():
 
580
            if is_inside_any(deleted_paths, path):
 
581
                # The tree will delete the required ids recursively.
 
582
                continue
 
583
            if specific and not is_inside_any(specific, path):
 
584
                continue
 
585
            if not self.work_tree.has_filename(path):
 
586
                deleted_paths.add(path)
 
587
                self.reporter.missing(path)
 
588
                deleted_ids.append(ie.file_id)
 
589
        self.work_tree.unversion(deleted_ids)
 
590
 
 
591
    def _populate_new_inv(self):
 
592
        """Build revision inventory.
 
593
 
 
594
        This creates a new empty inventory. Depending on
 
595
        which files are selected for commit, and what is present in the
 
596
        current tree, the new inventory is populated. inventory entries 
 
597
        which are candidates for modification have their revision set to
 
598
        None; inventory entries that are carried over untouched have their
 
599
        revision set to their prior value.
 
600
        """
 
601
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
602
        # results to create a new inventory at the same time, which results
 
603
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
604
        # ADHB 11-07-2006
 
605
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
606
        assert self.work_inv.root is not None
 
607
        entries = self.work_inv.iter_entries()
 
608
        if not self.builder.record_root_entry:
 
609
            symbol_versioning.warn('CommitBuilders should support recording'
 
610
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
611
                stacklevel=1)
 
612
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
613
            entries.next()
 
614
            self._emit_progress_update()
 
615
        for path, new_ie in entries:
 
616
            self._emit_progress_update()
 
617
            file_id = new_ie.file_id
 
618
            try:
 
619
                kind = self.work_tree.kind(file_id)
 
620
                if kind == 'tree-reference' and self.recursive == 'down':
 
621
                    # nested tree: commit in it
 
622
                    sub_tree = WorkingTree.open(self.work_tree.abspath(path))
 
623
                    # FIXME: be more comprehensive here:
 
624
                    # this works when both trees are in --trees repository,
 
625
                    # but when both are bound to a different repository,
 
626
                    # it fails; a better way of approaching this is to 
 
627
                    # finally implement the explicit-caches approach design
 
628
                    # a while back - RBC 20070306.
 
629
                    if (sub_tree.branch.repository.bzrdir.root_transport.base
 
630
                        ==
 
631
                        self.work_tree.branch.repository.bzrdir.root_transport.base):
 
632
                        sub_tree.branch.repository = \
 
633
                            self.work_tree.branch.repository
 
634
                    try:
 
635
                        sub_tree.commit(message=None, revprops=self.revprops,
 
636
                            recursive=self.recursive,
 
637
                            message_callback=self.message_callback,
 
638
                            timestamp=self.timestamp, timezone=self.timezone,
 
639
                            committer=self.committer,
 
640
                            allow_pointless=self.allow_pointless,
 
641
                            strict=self.strict, verbose=self.verbose,
 
642
                            local=self.local, reporter=self.reporter)
 
643
                    except errors.PointlessCommit:
 
644
                        pass
 
645
                if kind != new_ie.kind:
 
646
                    new_ie = inventory.make_entry(kind, new_ie.name,
 
647
                                                  new_ie.parent_id, file_id)
 
648
            except errors.NoSuchFile:
241
649
                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
 
650
            # mutter('check %s {%s}', path, file_id)
 
651
            if (not self.specific_files or 
 
652
                is_inside_or_parent_of_any(self.specific_files, path)):
 
653
                    # mutter('%s selected for commit', path)
 
654
                    ie = new_ie.copy()
 
655
                    ie.revision = None
 
656
            else:
 
657
                # mutter('%s not selected for commit', path)
 
658
                if self.basis_inv.has_id(file_id):
 
659
                    ie = self.basis_inv[file_id].copy()
 
660
                else:
 
661
                    # this entry is new and not being committed
 
662
                    continue
 
663
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
664
                path, self.work_tree)
 
665
            # describe the nature of the change that has occurred relative to
 
666
            # the basis inventory.
 
667
            if (self.basis_inv.has_id(ie.file_id)):
 
668
                basis_ie = self.basis_inv[ie.file_id]
 
669
            else:
 
670
                basis_ie = None
 
671
            change = ie.describe_change(basis_ie, ie)
 
672
            if change in (InventoryEntry.RENAMED, 
 
673
                InventoryEntry.MODIFIED_AND_RENAMED):
 
674
                old_path = self.basis_inv.id2path(ie.file_id)
 
675
                self.reporter.renamed(change, old_path, path)
 
676
            else:
 
677
                self.reporter.snapshot_change(change, path)
 
678
 
 
679
        if not self.specific_files:
 
680
            return
 
681
 
 
682
        # ignore removals that don't match filespec
 
683
        for path, new_ie in self.basis_inv.iter_entries():
 
684
            if new_ie.file_id in self.work_inv:
 
685
                continue
 
686
            if is_inside_any(self.specific_files, path):
 
687
                continue
 
688
            ie = new_ie.copy()
 
689
            ie.revision = None
 
690
            self.builder.record_entry_contents(ie, self.parent_invs, path,
 
691
                                               self.basis_tree)
 
692
 
 
693
    def _emit_progress_update(self):
 
694
        """Emit an update to the progress bar."""
 
695
        self.pb.update("Committing", self.pb_count, self.pb_total)
 
696
        self.pb_count += 1
 
697
 
 
698
    def _report_deletes(self):
 
699
        for path, ie in self.basis_inv.iter_entries():
 
700
            if ie.file_id not in self.builder.new_inventory:
 
701
                self.reporter.deleted(path)
311
702
 
312
703