/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: Canonical.com Patch Queue Manager
  • Date: 2007-09-17 23:11:44 UTC
  • mfrom: (2825.2.1 misc-fixen)
  • Revision ID: pqm@pqm.ubuntu.com-20070917231144-u7uxe56m03v95chg
(robertc) Micro-tweaks to sha routines. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
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
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?  Perhaps the best approach is to integrate commit of
20
 
# AtomicFiles with releasing the lock on the Branch.
21
 
 
22
 
# TODO: Separate 'prepare' phase where we find a list of potentially
23
 
# committed files.  We then can then pause the commit to prompt for a
24
 
# commit message, knowing the summary will be the same as what's
25
 
# actually used for the commit.  (But perhaps simpler to simply get
26
 
# the tree status, then use that for a selective commit?)
27
 
 
28
18
# The newly committed revision is going to have a shape corresponding
29
19
# to that of the working inventory.  Files that are not in the
30
20
# working tree and that were in the predecessor are reported as
56
46
# merges from, then it should still be reported as newly added
57
47
# relative to the basis revision.
58
48
 
59
 
# TODO: Do checks that the tree can be committed *before* running the 
60
 
# editor; this should include checks for a pointless commit and for 
61
 
# unknown or missing files.
62
 
 
63
 
# TODO: If commit fails, leave the message in a file somewhere.
64
 
 
 
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.
65
51
 
66
52
import os
67
53
import re
68
54
import sys
69
55
import time
70
 
import pdb
71
56
 
72
 
from binascii import hexlify
73
57
from cStringIO import StringIO
74
58
 
75
 
from bzrlib.atomicfile import AtomicFile
76
 
from bzrlib.osutils import (local_time_offset,
77
 
                            rand_bytes, compact_date,
78
 
                            kind_marker, is_inside_any, quotefn,
79
 
                            sha_file, isdir, isfile,
80
 
                            split_lines)
 
59
from bzrlib import (
 
60
    debug,
 
61
    errors,
 
62
    inventory,
 
63
    tree,
 
64
    )
 
65
from bzrlib.branch import Branch
81
66
import bzrlib.config
82
 
import bzrlib.errors as errors
83
67
from bzrlib.errors import (BzrError, PointlessCommit,
84
 
                           HistoryMissing,
85
68
                           ConflictsInTree,
86
69
                           StrictCommitFailed
87
70
                           )
88
 
from bzrlib.revision import Revision
 
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
72
                            is_inside_or_parent_of_any,
 
73
                            quotefn, sha_file, split_lines)
89
74
from bzrlib.testament import Testament
90
 
from bzrlib.trace import mutter, note, warning
 
75
from bzrlib.trace import mutter, note, warning, is_quiet
91
76
from bzrlib.xml5 import serializer_v5
92
 
from bzrlib.inventory import Inventory, ROOT_ID
93
 
from bzrlib.symbol_versioning import *
 
77
from bzrlib.inventory import Inventory, InventoryEntry
 
78
from bzrlib import symbol_versioning
 
79
from bzrlib.symbol_versioning import (deprecated_passed,
 
80
        deprecated_function,
 
81
        DEPRECATED_PARAMETER)
94
82
from bzrlib.workingtree import WorkingTree
95
 
 
96
 
 
97
 
@deprecated_function(zero_seven)
98
 
def commit(*args, **kwargs):
99
 
    """Commit a new revision to a branch.
100
 
 
101
 
    Function-style interface for convenience of old callers.
102
 
 
103
 
    New code should use the Commit class instead.
104
 
    """
105
 
    ## XXX: Remove this in favor of Branch.commit?
106
 
    Commit().commit(*args, **kwargs)
 
83
from bzrlib.urlutils import unescape_for_display
 
84
import bzrlib.ui
107
85
 
108
86
 
109
87
class NullCommitReporter(object):
110
88
    """I report on progress of a commit."""
111
89
 
 
90
    def started(self, revno, revid, location=None):
 
91
        pass
 
92
 
112
93
    def snapshot_change(self, change, path):
113
94
        pass
114
95
 
124
105
    def missing(self, path):
125
106
        pass
126
107
 
 
108
    def renamed(self, change, old_path, new_path):
 
109
        pass
 
110
 
 
111
    def is_verbose(self):
 
112
        return False
 
113
 
127
114
 
128
115
class ReportCommitToLog(NullCommitReporter):
129
116
 
 
117
    def _note(self, format, *args):
 
118
        """Output a message.
 
119
 
 
120
        Subclasses may choose to override this method.
 
121
        """
 
122
        note(format, *args)
 
123
 
130
124
    def snapshot_change(self, change, path):
131
125
        if change == 'unchanged':
132
126
            return
133
 
        note("%s %s", change, path)
 
127
        if change == 'added' and path == '':
 
128
            return
 
129
        self._note("%s %s", change, path)
 
130
 
 
131
    def started(self, revno, rev_id, location=None):
 
132
        if location is not None:
 
133
            location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
 
134
        else:
 
135
            location = ''
 
136
        self._note('Committing revision %d%s.', revno, location)
134
137
 
135
138
    def completed(self, revno, rev_id):
136
 
        note('Committed revision %d.', revno)
137
 
    
 
139
        self._note('Committed revision %d.', revno)
 
140
 
138
141
    def deleted(self, file_id):
139
 
        note('deleted %s', file_id)
 
142
        self._note('deleted %s', file_id)
140
143
 
141
144
    def escaped(self, escape_count, message):
142
 
        note("replaced %d control characters in message", escape_count)
 
145
        self._note("replaced %d control characters in message", escape_count)
143
146
 
144
147
    def missing(self, path):
145
 
        note('missing %s', path)
 
148
        self._note('missing %s', path)
 
149
 
 
150
    def renamed(self, change, old_path, new_path):
 
151
        self._note('%s %s => %s', change, old_path, new_path)
 
152
 
 
153
    def is_verbose(self):
 
154
        return True
146
155
 
147
156
 
148
157
class Commit(object):
160
169
    def __init__(self,
161
170
                 reporter=None,
162
171
                 config=None):
163
 
        if reporter is not None:
164
 
            self.reporter = reporter
165
 
        else:
166
 
            self.reporter = NullCommitReporter()
167
 
        if config is not None:
168
 
            self.config = config
169
 
        else:
170
 
            self.config = None
171
 
        
 
172
        """Create a Commit object.
 
173
 
 
174
        :param reporter: the default reporter to use or None to decide later
 
175
        """
 
176
        self.reporter = reporter
 
177
        self.config = config
 
178
 
172
179
    def commit(self,
173
 
               branch=DEPRECATED_PARAMETER, message=None,
 
180
               message=None,
174
181
               timestamp=None,
175
182
               timezone=None,
176
183
               committer=None,
183
190
               working_tree=None,
184
191
               local=False,
185
192
               reporter=None,
186
 
               config=None):
 
193
               config=None,
 
194
               message_callback=None,
 
195
               recursive='down'):
187
196
        """Commit working copy as a new revision.
188
197
 
189
 
        branch -- the deprecated branch to commit to. New callers should pass in 
190
 
                  working_tree instead
191
 
 
192
 
        message -- the commit message, a mandatory parameter
193
 
 
194
 
        timestamp -- if not None, seconds-since-epoch for a
195
 
             postdated/predated commit.
196
 
 
197
 
        specific_files -- If true, commit only those files.
198
 
 
199
 
        rev_id -- If set, use this as the new revision id.
 
198
        :param message: the commit message (it or message_callback is required)
 
199
 
 
200
        :param timestamp: if not None, seconds-since-epoch for a
 
201
            postdated/predated commit.
 
202
 
 
203
        :param specific_files: If true, commit only those files.
 
204
 
 
205
        :param rev_id: If set, use this as the new revision id.
200
206
            Useful for test or import commands that need to tightly
201
207
            control what revisions are assigned.  If you duplicate
202
208
            a revision id that exists elsewhere it is your own fault.
203
209
            If null (default), a time/random revision id is generated.
204
210
 
205
 
        allow_pointless -- If true (default), commit even if nothing
 
211
        :param allow_pointless: If true (default), commit even if nothing
206
212
            has changed and no merges are recorded.
207
213
 
208
 
        strict -- If true, don't allow a commit if the working tree
 
214
        :param strict: If true, don't allow a commit if the working tree
209
215
            contains unknown files.
210
216
 
211
 
        revprops -- Properties for new revision
 
217
        :param revprops: Properties for new revision
212
218
        :param local: Perform a local only commit.
 
219
        :param reporter: the reporter to use or None for the default
 
220
        :param verbose: if True and the reporter is not None, report everything
 
221
        :param recursive: If set to 'down', commit in any subtrees that have
 
222
            pending changes of any sort during this commit.
213
223
        """
214
224
        mutter('preparing to commit')
215
225
 
216
 
        if deprecated_passed(branch):
217
 
            warn("Commit.commit (branch, ...): The branch parameter is "
218
 
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
219
 
                 DeprecationWarning, stacklevel=2)
220
 
            self.branch = branch
221
 
            self.work_tree = self.branch.bzrdir.open_workingtree()
222
 
        elif working_tree is None:
223
 
            raise BzrError("One of branch and working_tree must be passed into commit().")
 
226
        if working_tree is None:
 
227
            raise BzrError("working_tree must be passed into commit().")
224
228
        else:
225
229
            self.work_tree = working_tree
226
230
            self.branch = self.work_tree.branch
227
 
        if message is None:
228
 
            raise BzrError("The message keyword parameter is required for commit().")
 
231
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
232
                if not self.branch.repository.supports_rich_root():
 
233
                    raise errors.RootNotRich()
 
234
        if message_callback is None:
 
235
            if message is not None:
 
236
                if isinstance(message, str):
 
237
                    message = message.decode(bzrlib.user_encoding)
 
238
                message_callback = lambda x: message
 
239
            else:
 
240
                raise BzrError("The message or message_callback keyword"
 
241
                               " parameter is required for commit().")
229
242
 
230
 
        self.weave_store = self.branch.repository.weave_store
231
243
        self.bound_branch = None
232
244
        self.local = local
233
245
        self.master_branch = None
234
246
        self.master_locked = False
235
 
        self.rev_id = rev_id
 
247
        self.rev_id = None
236
248
        self.specific_files = specific_files
237
249
        self.allow_pointless = allow_pointless
238
 
        self.revprops = {}
239
 
        if revprops is not None:
240
 
            self.revprops.update(revprops)
241
 
 
242
 
        if reporter is None and self.reporter is None:
243
 
            self.reporter = NullCommitReporter()
244
 
        elif reporter is not None:
245
 
            self.reporter = reporter
 
250
        self.recursive = recursive
 
251
        self.revprops = revprops
 
252
        self.message_callback = message_callback
 
253
        self.timestamp = timestamp
 
254
        self.timezone = timezone
 
255
        self.committer = committer
 
256
        self.strict = strict
 
257
        self.verbose = verbose
246
258
 
247
259
        self.work_tree.lock_write()
 
260
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
261
        self.basis_tree = self.work_tree.basis_tree()
 
262
        self.basis_tree.lock_read()
248
263
        try:
249
 
            # setup the bound branch variables as needed.
 
264
            # Cannot commit with conflicts present.
 
265
            if len(self.work_tree.conflicts()) > 0:
 
266
                raise ConflictsInTree
 
267
 
 
268
            # Setup the bound branch variables as needed.
250
269
            self._check_bound_branch()
251
270
 
252
 
            # check for out of date working trees
253
 
            # if we are bound, then self.branch is the master branch and this
254
 
            # test is thus all we need.
255
 
            if self.work_tree.last_revision() != self.master_branch.last_revision():
256
 
                raise errors.OutOfDateTree(self.work_tree)
257
 
    
258
 
            if strict:
259
 
                # raise an exception as soon as we find a single unknown.
260
 
                for unknown in self.work_tree.unknowns():
261
 
                    raise StrictCommitFailed()
262
 
    
263
 
            if timestamp is None:
264
 
                self.timestamp = time.time()
265
 
            else:
266
 
                self.timestamp = long(timestamp)
267
 
                
 
271
            # Check that the working tree is up to date
 
272
            old_revno, new_revno = self._check_out_of_date_tree()
 
273
 
 
274
            # Complete configuration setup
 
275
            if reporter is not None:
 
276
                self.reporter = reporter
 
277
            elif self.reporter is None:
 
278
                self.reporter = self._select_reporter()
268
279
            if self.config is None:
269
 
                self.config = bzrlib.config.BranchConfig(self.branch)
270
 
    
271
 
            if rev_id is None:
272
 
                self.rev_id = _gen_revision_id(self.config, self.timestamp)
273
 
            else:
274
 
                self.rev_id = rev_id
275
 
    
276
 
            if committer is None:
277
 
                self.committer = self.config.username()
278
 
            else:
279
 
                assert isinstance(committer, basestring), type(committer)
280
 
                self.committer = committer
281
 
    
282
 
            if timezone is None:
283
 
                self.timezone = local_time_offset()
284
 
            else:
285
 
                self.timezone = int(timezone)
286
 
    
287
 
            if isinstance(message, str):
288
 
                message = message.decode(bzrlib.user_encoding)
289
 
            assert isinstance(message, unicode), type(message)
290
 
            self.message = message
291
 
            self._escape_commit_message()
292
 
 
293
 
            self.work_inv = self.work_tree.inventory
294
 
            self.basis_tree = self.work_tree.basis_tree()
 
280
                self.config = self.branch.get_config()
 
281
 
 
282
            # If provided, ensure the specified files are versioned
 
283
            if specific_files is not None:
 
284
                # Note: We don't actually need the IDs here. This routine
 
285
                # is being called because it raises PathNotVerisonedError
 
286
                # as a side effect of finding the IDs.
 
287
                # XXX: Dont we have filter_unversioned to do this more
 
288
                # cheaply?
 
289
                tree.find_ids_across_trees(specific_files,
 
290
                                           [self.basis_tree, self.work_tree])
 
291
 
 
292
            # Setup the progress bar. As the number of files that need to be
 
293
            # committed in unknown, progress is reported as stages.
 
294
            # We keep track of entries separately though and include that
 
295
            # information in the progress bar during the relevant stages.
 
296
            self.pb_stage_name = ""
 
297
            self.pb_stage_count = 0
 
298
            self.pb_stage_total = 5
 
299
            if self.bound_branch:
 
300
                self.pb_stage_total += 1
 
301
            self.pb.show_pct = False
 
302
            self.pb.show_spinner = False
 
303
            self.pb.show_eta = False
 
304
            self.pb.show_count = True
 
305
            self.pb.show_bar = True
 
306
 
 
307
            # After a merge, a selected file commit is not supported.
 
308
            # See 'bzr help merge' for an explanation as to why.
295
309
            self.basis_inv = self.basis_tree.inventory
296
 
 
297
310
            self._gather_parents()
298
311
            if len(self.parents) > 1 and self.specific_files:
299
 
                raise NotImplementedError('selected-file commit of merges is not supported yet')
300
 
            self._check_parents_present()
301
 
            
302
 
            self._remove_deleted()
303
 
            self._populate_new_inv()
304
 
            self._store_snapshot()
305
 
            self._report_deletes()
306
 
 
307
 
            if not (self.allow_pointless
308
 
                    or len(self.parents) > 1
309
 
                    or self.new_inv != self.basis_inv):
310
 
                raise PointlessCommit()
311
 
 
312
 
            if len(self.work_tree.conflicts())>0:
313
 
                raise ConflictsInTree
314
 
 
315
 
            self.inv_sha1 = self.branch.repository.add_inventory(
316
 
                self.rev_id,
317
 
                self.new_inv,
318
 
                self.present_parents
319
 
                )
320
 
            self._make_revision()
321
 
            # revision data is in the local branch now.
322
 
            
323
 
            # upload revision data to the master.
324
 
            # this will propogate merged revisions too if needed.
 
312
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
313
 
 
314
            # Collect the changes
 
315
            self._set_progress_stage("Collecting changes",
 
316
                    entries_title="Directory")
 
317
            self.builder = self.branch.get_commit_builder(self.parents,
 
318
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
319
            
 
320
            try:
 
321
                # find the location being committed to
 
322
                if self.bound_branch:
 
323
                    master_location = self.master_branch.base
 
324
                else:
 
325
                    master_location = self.branch.base
 
326
 
 
327
                # report the start of the commit
 
328
                self.reporter.started(new_revno, self.rev_id, master_location)
 
329
 
 
330
                self._update_builder_with_changes()
 
331
                self._check_pointless()
 
332
 
 
333
                # TODO: Now the new inventory is known, check for conflicts.
 
334
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
335
                # weave lines, because nothing should be recorded until it is known
 
336
                # that commit will succeed.
 
337
                self._set_progress_stage("Saving data locally")
 
338
                self.builder.finish_inventory()
 
339
 
 
340
                # Prompt the user for a commit message if none provided
 
341
                message = message_callback(self)
 
342
                assert isinstance(message, unicode), type(message)
 
343
                self.message = message
 
344
                self._escape_commit_message()
 
345
 
 
346
                # Add revision data to the local branch
 
347
                self.rev_id = self.builder.commit(self.message)
 
348
 
 
349
            except:
 
350
                self.builder.abort()
 
351
                raise
 
352
 
 
353
            self._process_pre_hooks(old_revno, new_revno)
 
354
 
 
355
            # Upload revision data to the master.
 
356
            # this will propagate merged revisions too if needed.
325
357
            if self.bound_branch:
 
358
                self._set_progress_stage("Uploading data to master branch")
326
359
                self.master_branch.repository.fetch(self.branch.repository,
327
360
                                                    revision_id=self.rev_id)
328
361
                # now the master has the revision data
329
 
                # 'commit' to the master first so a timeout here causes the local
330
 
                # branch to be out of date
331
 
                self.master_branch.append_revision(self.rev_id)
 
362
                # 'commit' to the master first so a timeout here causes the
 
363
                # local branch to be out of date
 
364
                self.master_branch.set_last_revision_info(new_revno,
 
365
                                                          self.rev_id)
332
366
 
333
367
            # and now do the commit locally.
334
 
            self.branch.append_revision(self.rev_id)
 
368
            self.branch.set_last_revision_info(new_revno, self.rev_id)
335
369
 
336
 
            self.work_tree.set_pending_merges([])
337
 
            self.work_tree.set_last_revision(self.rev_id)
338
 
            # now the work tree is up to date with the branch
339
 
            
340
 
            self.reporter.completed(self.branch.revno(), self.rev_id)
341
 
            if self.config.post_commit() is not None:
342
 
                hooks = self.config.post_commit().split(' ')
343
 
                # this would be nicer with twisted.python.reflect.namedAny
344
 
                for hook in hooks:
345
 
                    result = eval(hook + '(branch, rev_id)',
346
 
                                  {'branch':self.branch,
347
 
                                   'bzrlib':bzrlib,
348
 
                                   'rev_id':self.rev_id})
 
370
            # Make the working tree up to date with the branch
 
371
            self._set_progress_stage("Updating the working tree")
 
372
            rev_tree = self.builder.revision_tree()
 
373
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
374
            self.reporter.completed(new_revno, self.rev_id)
 
375
            self._process_post_hooks(old_revno, new_revno)
349
376
        finally:
350
 
            self._cleanup_bound_branch()
351
 
            self.work_tree.unlock()
 
377
            self._cleanup()
 
378
        return self.rev_id
 
379
 
 
380
    def _select_reporter(self):
 
381
        """Select the CommitReporter to use."""
 
382
        if is_quiet():
 
383
            return NullCommitReporter()
 
384
        return ReportCommitToLog()
 
385
 
 
386
    def _any_real_changes(self):
 
387
        """Are there real changes between new_inventory and basis?
 
388
 
 
389
        For trees without rich roots, inv.root.revision changes every commit.
 
390
        But if that is the only change, we want to treat it as though there
 
391
        are *no* changes.
 
392
        """
 
393
        new_entries = self.builder.new_inventory.iter_entries()
 
394
        basis_entries = self.basis_inv.iter_entries()
 
395
        new_path, new_root_ie = new_entries.next()
 
396
        basis_path, basis_root_ie = basis_entries.next()
 
397
 
 
398
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
399
        def ie_equal_no_revision(this, other):
 
400
            return ((this.file_id == other.file_id)
 
401
                    and (this.name == other.name)
 
402
                    and (this.symlink_target == other.symlink_target)
 
403
                    and (this.text_sha1 == other.text_sha1)
 
404
                    and (this.text_size == other.text_size)
 
405
                    and (this.text_id == other.text_id)
 
406
                    and (this.parent_id == other.parent_id)
 
407
                    and (this.kind == other.kind)
 
408
                    and (this.executable == other.executable)
 
409
                    and (this.reference_revision == other.reference_revision)
 
410
                    )
 
411
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
412
            return True
 
413
 
 
414
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
415
            if new_ie != basis_ie:
 
416
                return True
 
417
 
 
418
        # No actual changes present
 
419
        return False
 
420
 
 
421
    def _check_pointless(self):
 
422
        if self.allow_pointless:
 
423
            return
 
424
        # A merge with no effect on files
 
425
        if len(self.parents) > 1:
 
426
            return
 
427
        # work around the fact that a newly-initted tree does differ from its
 
428
        # basis
 
429
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
 
430
            raise PointlessCommit()
 
431
        # Shortcut, if the number of entries changes, then we obviously have
 
432
        # a change
 
433
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
434
            return
 
435
        # If length == 1, then we only have the root entry. Which means
 
436
        # that there is no real difference (only the root could be different)
 
437
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
 
438
            return
 
439
        raise PointlessCommit()
352
440
 
353
441
    def _check_bound_branch(self):
354
442
        """Check to see if the local branch is bound.
380
468
        #       to local.
381
469
        
382
470
        # Make sure the local branch is identical to the master
383
 
        master_rh = self.master_branch.revision_history()
384
 
        local_rh = self.branch.revision_history()
385
 
        if local_rh != master_rh:
 
471
        master_info = self.master_branch.last_revision_info()
 
472
        local_info = self.branch.last_revision_info()
 
473
        if local_info != master_info:
386
474
            raise errors.BoundBranchOutOfDate(self.branch,
387
475
                    self.master_branch)
388
476
 
391
479
        self.bound_branch = self.branch
392
480
        self.master_branch.lock_write()
393
481
        self.master_locked = True
394
 
####        
395
 
####        # Check to see if we have any pending merges. If we do
396
 
####        # those need to be pushed into the master branch
397
 
####        pending_merges = self.work_tree.pending_merges()
398
 
####        if pending_merges:
399
 
####            for revision_id in pending_merges:
400
 
####                self.master_branch.repository.fetch(self.bound_branch.repository,
401
 
####                                                    revision_id=revision_id)
 
482
 
 
483
    def _check_out_of_date_tree(self):
 
484
        """Check that the working tree is up to date.
 
485
 
 
486
        :return: old_revision_number,new_revision_number tuple
 
487
        """
 
488
        try:
 
489
            first_tree_parent = self.work_tree.get_parent_ids()[0]
 
490
        except IndexError:
 
491
            # if there are no parents, treat our parent as 'None'
 
492
            # this is so that we still consider the master branch
 
493
            # - in a checkout scenario the tree may have no
 
494
            # parents but the branch may do.
 
495
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
496
        old_revno, master_last = self.master_branch.last_revision_info()
 
497
        if master_last != first_tree_parent:
 
498
            if master_last != bzrlib.revision.NULL_REVISION:
 
499
                raise errors.OutOfDateTree(self.work_tree)
 
500
        if self.branch.repository.has_revision(first_tree_parent):
 
501
            new_revno = old_revno + 1
 
502
        else:
 
503
            # ghost parents never appear in revision history.
 
504
            new_revno = 1
 
505
        return old_revno,new_revno
 
506
 
 
507
    def _process_pre_hooks(self, old_revno, new_revno):
 
508
        """Process any registered pre commit hooks."""
 
509
        self._set_progress_stage("Running pre_commit hooks")
 
510
        self._process_hooks("pre_commit", old_revno, new_revno)
 
511
 
 
512
    def _process_post_hooks(self, old_revno, new_revno):
 
513
        """Process any registered post commit hooks."""
 
514
        # Process the post commit hooks, if any
 
515
        self._set_progress_stage("Running post_commit hooks")
 
516
        # old style commit hooks - should be deprecated ? (obsoleted in
 
517
        # 0.15)
 
518
        if self.config.post_commit() is not None:
 
519
            hooks = self.config.post_commit().split(' ')
 
520
            # this would be nicer with twisted.python.reflect.namedAny
 
521
            for hook in hooks:
 
522
                result = eval(hook + '(branch, rev_id)',
 
523
                              {'branch':self.branch,
 
524
                               'bzrlib':bzrlib,
 
525
                               'rev_id':self.rev_id})
 
526
        # process new style post commit hooks
 
527
        self._process_hooks("post_commit", old_revno, new_revno)
 
528
 
 
529
    def _process_hooks(self, hook_name, old_revno, new_revno):
 
530
        if not Branch.hooks[hook_name]:
 
531
            return
 
532
        
 
533
        # new style commit hooks:
 
534
        if not self.bound_branch:
 
535
            hook_master = self.branch
 
536
            hook_local = None
 
537
        else:
 
538
            hook_master = self.master_branch
 
539
            hook_local = self.branch
 
540
        # With bound branches, when the master is behind the local branch,
 
541
        # the 'old_revno' and old_revid values here are incorrect.
 
542
        # XXX: FIXME ^. RBC 20060206
 
543
        if self.parents:
 
544
            old_revid = self.parents[0]
 
545
        else:
 
546
            old_revid = bzrlib.revision.NULL_REVISION
 
547
        
 
548
        if hook_name == "pre_commit":
 
549
            future_tree = self.builder.revision_tree()
 
550
            tree_delta = future_tree.changes_from(self.basis_tree,
 
551
                                             include_root=True)
 
552
        
 
553
        for hook in Branch.hooks[hook_name]:
 
554
            # show the running hook in the progress bar. As hooks may
 
555
            # end up doing nothing (e.g. because they are not configured by
 
556
            # the user) this is still showing progress, not showing overall
 
557
            # actions - its up to each plugin to show a UI if it want's to
 
558
            # (such as 'Emailing diff to foo@example.com').
 
559
            self.pb_stage_name = "Running %s hooks [%s]" % \
 
560
                (hook_name, Branch.hooks.get_hook_name(hook))
 
561
            self._emit_progress()
 
562
            if 'hooks' in debug.debug_flags:
 
563
                mutter("Invoking commit hook: %r", hook)
 
564
            if hook_name == "post_commit":
 
565
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
566
                     self.rev_id)
 
567
            elif hook_name == "pre_commit":
 
568
                hook(hook_local, hook_master,
 
569
                     old_revno, old_revid, new_revno, self.rev_id,
 
570
                     tree_delta, future_tree)
 
571
 
 
572
    def _cleanup(self):
 
573
        """Cleanup any open locks, progress bars etc."""
 
574
        cleanups = [self._cleanup_bound_branch,
 
575
                    self.basis_tree.unlock,
 
576
                    self.work_tree.unlock,
 
577
                    self.pb.finished]
 
578
        found_exception = None
 
579
        for cleanup in cleanups:
 
580
            try:
 
581
                cleanup()
 
582
            # we want every cleanup to run no matter what.
 
583
            # so we have a catchall here, but we will raise the
 
584
            # last encountered exception up the stack: and
 
585
            # typically this will be useful enough.
 
586
            except Exception, e:
 
587
                found_exception = e
 
588
        if found_exception is not None: 
 
589
            # don't do a plan raise, because the last exception may have been
 
590
            # trashed, e is our sure-to-work exception even though it loses the
 
591
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
592
            # exc_info and if its the same one do a plain raise otherwise 
 
593
            # 'raise e' as we do now.
 
594
            raise e
402
595
 
403
596
    def _cleanup_bound_branch(self):
404
597
        """Executed at the end of a try/finally to cleanup a bound branch.
414
607
 
415
608
    def _escape_commit_message(self):
416
609
        """Replace xml-incompatible control characters."""
 
610
        # FIXME: RBC 20060419 this should be done by the revision
 
611
        # serialiser not by commit. Then we can also add an unescaper
 
612
        # in the deserializer and start roundtripping revision messages
 
613
        # precisely. See repository_implementations/test_repository.py
 
614
        
417
615
        # Python strings can include characters that can't be
418
616
        # represented in well-formed XML; escape characters that
419
617
        # aren't listed in the XML specification
427
625
 
428
626
    def _gather_parents(self):
429
627
        """Record the parents of a merge for merge detection."""
430
 
        pending_merges = self.work_tree.pending_merges()
431
 
        self.parents = []
432
 
        self.parent_invs = []
433
 
        self.present_parents = []
434
 
        precursor_id = self.branch.last_revision()
435
 
        if precursor_id:
436
 
            self.parents.append(precursor_id)
437
 
        self.parents += pending_merges
438
 
        for revision in self.parents:
 
628
        # TODO: Make sure that this list doesn't contain duplicate 
 
629
        # entries and the order is preserved when doing this.
 
630
        self.parents = self.work_tree.get_parent_ids()
 
631
        self.parent_invs = [self.basis_inv]
 
632
        for revision in self.parents[1:]:
439
633
            if self.branch.repository.has_revision(revision):
 
634
                mutter('commit parent revision {%s}', revision)
440
635
                inventory = self.branch.repository.get_inventory(revision)
441
636
                self.parent_invs.append(inventory)
442
 
                self.present_parents.append(revision)
443
 
 
444
 
    def _check_parents_present(self):
445
 
        for parent_id in self.parents:
446
 
            mutter('commit parent revision {%s}', parent_id)
447
 
            if not self.branch.repository.has_revision(parent_id):
448
 
                if parent_id == self.branch.last_revision():
449
 
                    warning("parent is missing %r", parent_id)
450
 
                    raise HistoryMissing(self.branch, 'revision', parent_id)
451
 
                else:
452
 
                    mutter("commit will ghost revision %r", parent_id)
453
 
            
454
 
    def _make_revision(self):
455
 
        """Record a new revision object for this commit."""
456
 
        rev = Revision(timestamp=self.timestamp,
457
 
                       timezone=self.timezone,
458
 
                       committer=self.committer,
459
 
                       message=self.message,
460
 
                       inventory_sha1=self.inv_sha1,
461
 
                       revision_id=self.rev_id,
462
 
                       properties=self.revprops)
463
 
        rev.parent_ids = self.parents
464
 
        self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
465
 
 
466
 
    def _remove_deleted(self):
467
 
        """Remove deleted files from the working inventories.
468
 
 
469
 
        This is done prior to taking the working inventory as the
470
 
        basis for the new committed inventory.
471
 
 
472
 
        This returns true if any files
473
 
        *that existed in the basis inventory* were deleted.
474
 
        Files that were added and deleted
475
 
        in the working copy don't matter.
 
637
            else:
 
638
                mutter('commit parent ghost revision {%s}', revision)
 
639
 
 
640
    def _update_builder_with_changes(self):
 
641
        """Update the commit builder with the data about what has changed.
476
642
        """
477
 
        specific = self.specific_files
 
643
        # Build the revision inventory.
 
644
        #
 
645
        # This starts by creating a new empty inventory. Depending on
 
646
        # which files are selected for commit, and what is present in the
 
647
        # current tree, the new inventory is populated. inventory entries 
 
648
        # which are candidates for modification have their revision set to
 
649
        # None; inventory entries that are carried over untouched have their
 
650
        # revision set to their prior value.
 
651
        #
 
652
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
653
        # results to create a new inventory at the same time, which results
 
654
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
655
        # ADHB 11-07-2006
 
656
 
 
657
        specific_files = self.specific_files
 
658
        mutter("Selecting files for commit with filter %s", specific_files)
 
659
 
 
660
        # Check and warn about old CommitBuilders
 
661
        if not self.builder.record_root_entry:
 
662
            symbol_versioning.warn('CommitBuilders should support recording'
 
663
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
664
                stacklevel=1)
 
665
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
666
 
 
667
        # Build the new inventory
 
668
        self._populate_from_inventory(specific_files)
 
669
 
 
670
        # If specific files are selected, then all un-selected files must be
 
671
        # recorded in their previous state. For more details, see
 
672
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
673
        if specific_files:
 
674
            for path, new_ie in self.basis_inv.iter_entries():
 
675
                if new_ie.file_id in self.builder.new_inventory:
 
676
                    continue
 
677
                if is_inside_any(specific_files, path):
 
678
                    continue
 
679
                ie = new_ie.copy()
 
680
                ie.revision = None
 
681
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
682
                                                   self.basis_tree)
 
683
 
 
684
        # Report what was deleted.
 
685
        if self.reporter.is_verbose():
 
686
            for path, ie in self.basis_inv.iter_entries():
 
687
                if ie.file_id not in self.builder.new_inventory:
 
688
                    self.reporter.deleted(path)
 
689
 
 
690
    def _populate_from_inventory(self, specific_files):
 
691
        """Populate the CommitBuilder by walking the working tree inventory."""
 
692
        if self.strict:
 
693
            # raise an exception as soon as we find a single unknown.
 
694
            for unknown in self.work_tree.unknowns():
 
695
                raise StrictCommitFailed()
 
696
               
 
697
        report_changes = self.reporter.is_verbose()
478
698
        deleted_ids = []
479
 
        for path, ie in self.work_inv.iter_entries():
480
 
            if specific and not is_inside_any(specific, path):
 
699
        deleted_paths = set()
 
700
        work_inv = self.work_tree.inventory
 
701
        assert work_inv.root is not None
 
702
        entries = work_inv.iter_entries()
 
703
        if not self.builder.record_root_entry:
 
704
            entries.next()
 
705
        for path, existing_ie in entries:
 
706
            file_id = existing_ie.file_id
 
707
            name = existing_ie.name
 
708
            parent_id = existing_ie.parent_id
 
709
            kind = existing_ie.kind
 
710
            if kind == 'directory':
 
711
                self._next_progress_entry()
 
712
 
 
713
            # Skip files that have been deleted from the working tree.
 
714
            # The deleted files/directories are also recorded so they
 
715
            # can be explicitly unversioned later. Note that when a
 
716
            # filter of specific files is given, we must only skip/record
 
717
            # deleted files matching that filter.
 
718
            if is_inside_any(deleted_paths, path):
481
719
                continue
482
 
            if not self.work_tree.has_filename(path):
483
 
                self.reporter.missing(path)
484
 
                deleted_ids.append((path, ie.file_id))
485
 
        if deleted_ids:
486
 
            deleted_ids.sort(reverse=True)
487
 
            for path, file_id in deleted_ids:
488
 
                del self.work_inv[file_id]
489
 
            self.work_tree._write_inventory(self.work_inv)
490
 
 
491
 
    def _store_snapshot(self):
492
 
        """Pass over inventory and record a snapshot.
493
 
 
494
 
        Entries get a new revision when they are modified in 
495
 
        any way, which includes a merge with a new set of
496
 
        parents that have the same entry. 
 
720
            if not specific_files or is_inside_any(specific_files, path):
 
721
                if not self.work_tree.has_filename(path):
 
722
                    deleted_paths.add(path)
 
723
                    self.reporter.missing(path)
 
724
                    deleted_ids.append(file_id)
 
725
                    continue
 
726
            try:
 
727
                kind = self.work_tree.kind(file_id)
 
728
                # TODO: specific_files filtering before nested tree processing
 
729
                if kind == 'tree-reference' and self.recursive == 'down':
 
730
                    self._commit_nested_tree(file_id, path)
 
731
            except errors.NoSuchFile:
 
732
                pass
 
733
 
 
734
            # Record an entry for this item
 
735
            # Note: I don't particularly want to have the existing_ie
 
736
            # parameter but the test suite currently (28-Jun-07) breaks
 
737
            # without it thanks to a unicode normalisation issue. :-(
 
738
            definitely_changed = kind != existing_ie.kind 
 
739
            self._record_entry(path, file_id, specific_files, kind, name,
 
740
                parent_id, definitely_changed, existing_ie, report_changes)
 
741
 
 
742
        # Unversion IDs that were found to be deleted
 
743
        self.work_tree.unversion(deleted_ids)
 
744
 
 
745
    def _commit_nested_tree(self, file_id, path):
 
746
        "Commit a nested tree."
 
747
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
 
748
        # FIXME: be more comprehensive here:
 
749
        # this works when both trees are in --trees repository,
 
750
        # but when both are bound to a different repository,
 
751
        # it fails; a better way of approaching this is to 
 
752
        # finally implement the explicit-caches approach design
 
753
        # a while back - RBC 20070306.
 
754
        if sub_tree.branch.repository.has_same_location(
 
755
            self.work_tree.branch.repository):
 
756
            sub_tree.branch.repository = \
 
757
                self.work_tree.branch.repository
 
758
        try:
 
759
            sub_tree.commit(message=None, revprops=self.revprops,
 
760
                recursive=self.recursive,
 
761
                message_callback=self.message_callback,
 
762
                timestamp=self.timestamp, timezone=self.timezone,
 
763
                committer=self.committer,
 
764
                allow_pointless=self.allow_pointless,
 
765
                strict=self.strict, verbose=self.verbose,
 
766
                local=self.local, reporter=self.reporter)
 
767
        except errors.PointlessCommit:
 
768
            pass
 
769
 
 
770
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
771
            parent_id, definitely_changed, existing_ie=None,
 
772
            report_changes=True):
 
773
        "Record the new inventory entry for a path if any."
 
774
        # mutter('check %s {%s}', path, file_id)
 
775
        if (not specific_files or 
 
776
            is_inside_or_parent_of_any(specific_files, path)):
 
777
                # mutter('%s selected for commit', path)
 
778
                if definitely_changed or existing_ie is None:
 
779
                    ie = inventory.make_entry(kind, name, parent_id, file_id)
 
780
                else:
 
781
                    ie = existing_ie.copy()
 
782
                    ie.revision = None
 
783
        else:
 
784
            # mutter('%s not selected for commit', path)
 
785
            if self.basis_inv.has_id(file_id):
 
786
                ie = self.basis_inv[file_id].copy()
 
787
            else:
 
788
                # this entry is new and not being committed
 
789
                ie = None
 
790
        if ie is not None:
 
791
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
792
                path, self.work_tree)
 
793
            if report_changes:
 
794
                self._report_change(ie, path)
 
795
        return ie
 
796
 
 
797
    def _report_change(self, ie, path):
 
798
        """Report a change to the user.
 
799
 
 
800
        The change that has occurred is described relative to the basis
 
801
        inventory.
497
802
        """
498
 
        # XXX: Need to think more here about when the user has
499
 
        # made a specific decision on a particular value -- c.f.
500
 
        # mark-merge.  
501
 
        for path, ie in self.new_inv.iter_entries():
502
 
            previous_entries = ie.find_previous_heads(
503
 
                self.parent_invs,
504
 
                self.weave_store,
505
 
                self.branch.repository.get_transaction())
506
 
            if ie.revision is None:
507
 
                change = ie.snapshot(self.rev_id, path, previous_entries,
508
 
                                     self.work_tree, self.weave_store,
509
 
                                     self.branch.get_transaction())
510
 
            else:
511
 
                change = "unchanged"
 
803
        if (self.basis_inv.has_id(ie.file_id)):
 
804
            basis_ie = self.basis_inv[ie.file_id]
 
805
        else:
 
806
            basis_ie = None
 
807
        change = ie.describe_change(basis_ie, ie)
 
808
        if change in (InventoryEntry.RENAMED, 
 
809
            InventoryEntry.MODIFIED_AND_RENAMED):
 
810
            old_path = self.basis_inv.id2path(ie.file_id)
 
811
            self.reporter.renamed(change, old_path, path)
 
812
        else:
512
813
            self.reporter.snapshot_change(change, path)
513
814
 
514
 
    def _populate_new_inv(self):
515
 
        """Build revision inventory.
516
 
 
517
 
        This creates a new empty inventory. Depending on
518
 
        which files are selected for commit, and what is present in the
519
 
        current tree, the new inventory is populated. inventory entries 
520
 
        which are candidates for modification have their revision set to
521
 
        None; inventory entries that are carried over untouched have their
522
 
        revision set to their prior value.
523
 
        """
524
 
        mutter("Selecting files for commit with filter %s", self.specific_files)
525
 
        self.new_inv = Inventory(revision_id=self.rev_id)
526
 
        for path, new_ie in self.work_inv.iter_entries():
527
 
            file_id = new_ie.file_id
528
 
            mutter('check %s {%s}', path, new_ie.file_id)
529
 
            if self.specific_files:
530
 
                if not is_inside_any(self.specific_files, path):
531
 
                    mutter('%s not selected for commit', path)
532
 
                    self._carry_entry(file_id)
533
 
                    continue
534
 
                else:
535
 
                    # this is selected, ensure its parents are too.
536
 
                    parent_id = new_ie.parent_id
537
 
                    while parent_id != ROOT_ID:
538
 
                        if not self.new_inv.has_id(parent_id):
539
 
                            ie = self._select_entry(self.work_inv[parent_id])
540
 
                            mutter('%s selected for commit because of %s',
541
 
                                   self.new_inv.id2path(parent_id), path)
542
 
 
543
 
                        ie = self.new_inv[parent_id]
544
 
                        if ie.revision is not None:
545
 
                            ie.revision = None
546
 
                            mutter('%s selected for commit because of %s',
547
 
                                   self.new_inv.id2path(parent_id), path)
548
 
                        parent_id = ie.parent_id
549
 
            mutter('%s selected for commit', path)
550
 
            self._select_entry(new_ie)
551
 
 
552
 
    def _select_entry(self, new_ie):
553
 
        """Make new_ie be considered for committing."""
554
 
        ie = new_ie.copy()
555
 
        ie.revision = None
556
 
        self.new_inv.add(ie)
557
 
        return ie
558
 
 
559
 
    def _carry_entry(self, file_id):
560
 
        """Carry the file unchanged from the basis revision."""
561
 
        if self.basis_inv.has_id(file_id):
562
 
            self.new_inv.add(self.basis_inv[file_id].copy())
563
 
 
564
 
    def _report_deletes(self):
565
 
        for file_id in self.basis_inv:
566
 
            if file_id not in self.new_inv:
567
 
                self.reporter.deleted(self.basis_inv.id2path(file_id))
568
 
 
569
 
def _gen_revision_id(config, when):
570
 
    """Return new revision-id."""
571
 
    s = '%s-%s-' % (config.user_email(), compact_date(when))
572
 
    s += hexlify(rand_bytes(8))
573
 
    return s
 
815
    def _set_progress_stage(self, name, entries_title=None):
 
816
        """Set the progress stage and emit an update to the progress bar."""
 
817
        self.pb_stage_name = name
 
818
        self.pb_stage_count += 1
 
819
        self.pb_entries_title = entries_title
 
820
        if entries_title is not None:
 
821
            self.pb_entries_count = 0
 
822
            self.pb_entries_total = '?'
 
823
        self._emit_progress()
 
824
 
 
825
    def _next_progress_entry(self):
 
826
        """Emit an update to the progress bar and increment the entry count."""
 
827
        self.pb_entries_count += 1
 
828
        self._emit_progress()
 
829
 
 
830
    def _emit_progress(self):
 
831
        if self.pb_entries_title:
 
832
            if self.pb_entries_total == '?':
 
833
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
834
                    self.pb_entries_title, self.pb_entries_count)
 
835
            else:
 
836
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
837
                    self.pb_entries_title, self.pb_entries_count,
 
838
                    str(self.pb_entries_total))
 
839
        else:
 
840
            text = "%s - Stage" % (self.pb_stage_name)
 
841
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
842