/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-10-10 01:05:01 UTC
  • mfrom: (2872.5.5 129701-readonly-commit)
  • Revision ID: pqm@pqm.ubuntu.com-20071010010501-ejbj03m5w3k9vdsd
Avoid internal error tracebacks on failure to lock on readonly transport (#129701)

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