~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-03-21 04:49:05 UTC
  • mfrom: (2367.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070321044905-ded01a80ab49bdd9
Update NEWS to match bzr 0.15.

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