~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Wouter van Heyst
  • Date: 2007-01-18 18:37:21 UTC
  • mto: (2234.3.3 0.14)
  • mto: This revision was merged to the branch mainline in revision 2243.
  • Revision ID: larstiq@larstiq.dyndns.org-20070118183721-78uzxifyyyoqxja9
(Alexander Belchenko) add windows installer check for python2.5

Show diffs side-by-side

added added

removed removed

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