/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-11 01:03:53 UTC
  • mfrom: (2810.1.1 tag-overwrite)
  • Revision ID: pqm@pqm.ubuntu.com-20070911010353-6lu7ek40rbjhj86o
(lukas) Overwrite conflicting tags by push|pull --overwrite

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