~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Aaron Bentley
  • Date: 2009-03-24 15:47:32 UTC
  • mto: This revision was merged to the branch mainline in revision 4241.
  • Revision ID: aaron@aaronbentley.com-20090324154732-bwkvi4dx3o90a7dq
Add output, emit minimal inventory delta.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
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?)
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
27
17
 
28
18
# The newly committed revision is going to have a shape corresponding
29
 
# to that of the working inventory.  Files that are not in the
 
19
# to that of the working tree.  Files that are not in the
30
20
# working tree and that were in the predecessor are reported as
31
21
# removed --- this can include files that were either removed from the
32
22
# inventory or deleted in the working tree.  If they were only
35
25
# We then consider the remaining entries, which will be in the new
36
26
# version.  Directory entries are simply copied across.  File entries
37
27
# must be checked to see if a new version of the file should be
38
 
# recorded.  For each parent revision inventory, we check to see what
 
28
# recorded.  For each parent revision tree, we check to see what
39
29
# version of the file was present.  If the file was present in at
40
30
# least one tree, and if it was the same version in all the trees,
41
31
# then we can just refer to that version.  Otherwise, a new version
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 warnings
71
56
 
72
57
from cStringIO import StringIO
73
58
 
74
 
from bzrlib.atomicfile import AtomicFile
 
59
from bzrlib import (
 
60
    debug,
 
61
    errors,
 
62
    revision,
 
63
    trace,
 
64
    tree,
 
65
    )
 
66
from bzrlib.branch import Branch
75
67
import bzrlib.config
76
 
import bzrlib.errors as errors
77
68
from bzrlib.errors import (BzrError, PointlessCommit,
78
69
                           ConflictsInTree,
79
70
                           StrictCommitFailed
80
71
                           )
81
 
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
72
from bzrlib.osutils import (get_user_encoding,
 
73
                            kind_marker, isdir,isfile, is_inside_any,
82
74
                            is_inside_or_parent_of_any,
83
 
                            quotefn, sha_file, split_lines)
 
75
                            minimum_path_selection,
 
76
                            quotefn, sha_file, split_lines,
 
77
                            splitpath,
 
78
                            )
84
79
from bzrlib.testament import Testament
85
 
from bzrlib.trace import mutter, note, warning
86
 
from bzrlib.xml5 import serializer_v5
87
 
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
 
80
from bzrlib.trace import mutter, note, warning, is_quiet
 
81
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
82
from bzrlib import symbol_versioning
88
83
from bzrlib.symbol_versioning import (deprecated_passed,
89
84
        deprecated_function,
90
 
        zero_seven,
91
85
        DEPRECATED_PARAMETER)
92
86
from bzrlib.workingtree import WorkingTree
93
 
 
94
 
 
95
 
@deprecated_function(zero_seven)
96
 
def commit(*args, **kwargs):
97
 
    """Commit a new revision to a branch.
98
 
 
99
 
    Function-style interface for convenience of old callers.
100
 
 
101
 
    New code should use the Commit class instead.
102
 
    """
103
 
    ## XXX: Remove this in favor of WorkingTree.commit?
104
 
    Commit().commit(*args, **kwargs)
 
87
from bzrlib.urlutils import unescape_for_display
 
88
import bzrlib.ui
105
89
 
106
90
 
107
91
class NullCommitReporter(object):
108
92
    """I report on progress of a commit."""
109
93
 
 
94
    def started(self, revno, revid, location=None):
 
95
        if location is None:
 
96
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
97
                                   "to started.", DeprecationWarning,
 
98
                                   stacklevel=2)
 
99
        pass
 
100
 
110
101
    def snapshot_change(self, change, path):
111
102
        pass
112
103
 
125
116
    def renamed(self, change, old_path, new_path):
126
117
        pass
127
118
 
 
119
    def is_verbose(self):
 
120
        return False
 
121
 
128
122
 
129
123
class ReportCommitToLog(NullCommitReporter):
130
124
 
131
 
    # this may be more useful if 'note' was replaced by an overridable
132
 
    # method on self, which would allow more trivial subclassing.
133
 
    # alternative, a callable could be passed in, allowing really trivial
134
 
    # reuse for some uis. RBC 20060511
 
125
    def _note(self, format, *args):
 
126
        """Output a message.
 
127
 
 
128
        Subclasses may choose to override this method.
 
129
        """
 
130
        note(format, *args)
135
131
 
136
132
    def snapshot_change(self, change, path):
137
133
        if change == 'unchanged':
138
134
            return
139
 
        note("%s %s", change, path)
 
135
        if change == 'added' and path == '':
 
136
            return
 
137
        self._note("%s %s", change, path)
 
138
 
 
139
    def started(self, revno, rev_id, location=None):
 
140
        if location is not None:
 
141
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
142
        else:
 
143
            # When started was added, location was only made optional by
 
144
            # accident.  Matt Nordhoff 20071129
 
145
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
146
                                   "to started.", DeprecationWarning,
 
147
                                   stacklevel=2)
 
148
            location = ''
 
149
        self._note('Committing%s', location)
140
150
 
141
151
    def completed(self, revno, rev_id):
142
 
        note('Committed revision %d.', revno)
143
 
    
 
152
        self._note('Committed revision %d.', revno)
 
153
 
144
154
    def deleted(self, file_id):
145
 
        note('deleted %s', file_id)
 
155
        self._note('deleted %s', file_id)
146
156
 
147
157
    def escaped(self, escape_count, message):
148
 
        note("replaced %d control characters in message", escape_count)
 
158
        self._note("replaced %d control characters in message", escape_count)
149
159
 
150
160
    def missing(self, path):
151
 
        note('missing %s', path)
 
161
        self._note('missing %s', path)
152
162
 
153
163
    def renamed(self, change, old_path, new_path):
154
 
        note('%s %s => %s', change, old_path, new_path)
 
164
        self._note('%s %s => %s', change, old_path, new_path)
 
165
 
 
166
    def is_verbose(self):
 
167
        return True
155
168
 
156
169
 
157
170
class Commit(object):
169
182
    def __init__(self,
170
183
                 reporter=None,
171
184
                 config=None):
172
 
        if reporter is not None:
173
 
            self.reporter = reporter
174
 
        else:
175
 
            self.reporter = NullCommitReporter()
176
 
        if config is not None:
177
 
            self.config = config
178
 
        else:
179
 
            self.config = None
180
 
        
 
185
        """Create a Commit object.
 
186
 
 
187
        :param reporter: the default reporter to use or None to decide later
 
188
        """
 
189
        self.reporter = reporter
 
190
        self.config = config
 
191
 
181
192
    def commit(self,
182
 
               branch=DEPRECATED_PARAMETER, message=None,
 
193
               message=None,
183
194
               timestamp=None,
184
195
               timezone=None,
185
196
               committer=None,
192
203
               working_tree=None,
193
204
               local=False,
194
205
               reporter=None,
195
 
               config=None):
 
206
               config=None,
 
207
               message_callback=None,
 
208
               recursive='down',
 
209
               exclude=None,
 
210
               possible_master_transports=None):
196
211
        """Commit working copy as a new revision.
197
212
 
198
 
        branch -- the deprecated branch to commit to. New callers should pass in 
199
 
                  working_tree instead
200
 
 
201
 
        message -- the commit message, a mandatory parameter
202
 
 
203
 
        timestamp -- if not None, seconds-since-epoch for a
204
 
             postdated/predated commit.
205
 
 
206
 
        specific_files -- If true, commit only those files.
207
 
 
208
 
        rev_id -- If set, use this as the new revision id.
 
213
        :param message: the commit message (it or message_callback is required)
 
214
 
 
215
        :param timestamp: if not None, seconds-since-epoch for a
 
216
            postdated/predated commit.
 
217
 
 
218
        :param specific_files: If true, commit only those files.
 
219
 
 
220
        :param rev_id: If set, use this as the new revision id.
209
221
            Useful for test or import commands that need to tightly
210
222
            control what revisions are assigned.  If you duplicate
211
223
            a revision id that exists elsewhere it is your own fault.
212
224
            If null (default), a time/random revision id is generated.
213
225
 
214
 
        allow_pointless -- If true (default), commit even if nothing
 
226
        :param allow_pointless: If true (default), commit even if nothing
215
227
            has changed and no merges are recorded.
216
228
 
217
 
        strict -- If true, don't allow a commit if the working tree
 
229
        :param strict: If true, don't allow a commit if the working tree
218
230
            contains unknown files.
219
231
 
220
 
        revprops -- Properties for new revision
 
232
        :param revprops: Properties for new revision
221
233
        :param local: Perform a local only commit.
 
234
        :param reporter: the reporter to use or None for the default
 
235
        :param verbose: if True and the reporter is not None, report everything
 
236
        :param recursive: If set to 'down', commit in any subtrees that have
 
237
            pending changes of any sort during this commit.
 
238
        :param exclude: None or a list of relative paths to exclude from the
 
239
            commit. Pending changes to excluded files will be ignored by the
 
240
            commit.
222
241
        """
223
242
        mutter('preparing to commit')
224
243
 
225
 
        if deprecated_passed(branch):
226
 
            warnings.warn("Commit.commit (branch, ...): The branch parameter is "
227
 
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
228
 
                 DeprecationWarning, stacklevel=2)
229
 
            self.branch = branch
230
 
            self.work_tree = self.branch.bzrdir.open_workingtree()
231
 
        elif working_tree is None:
232
 
            raise BzrError("One of branch and working_tree must be passed into commit().")
 
244
        if working_tree is None:
 
245
            raise BzrError("working_tree must be passed into commit().")
233
246
        else:
234
247
            self.work_tree = working_tree
235
248
            self.branch = self.work_tree.branch
236
 
        if message is None:
237
 
            raise BzrError("The message keyword parameter is required for commit().")
 
249
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
250
                if not self.branch.repository.supports_rich_root():
 
251
                    raise errors.RootNotRich()
 
252
        if message_callback is None:
 
253
            if message is not None:
 
254
                if isinstance(message, str):
 
255
                    message = message.decode(get_user_encoding())
 
256
                message_callback = lambda x: message
 
257
            else:
 
258
                raise BzrError("The message or message_callback keyword"
 
259
                               " parameter is required for commit().")
238
260
 
239
261
        self.bound_branch = None
 
262
        self.any_entries_deleted = False
 
263
        if exclude is not None:
 
264
            self.exclude = sorted(
 
265
                minimum_path_selection(exclude))
 
266
        else:
 
267
            self.exclude = []
240
268
        self.local = local
241
269
        self.master_branch = None
242
270
        self.master_locked = False
 
271
        self.recursive = recursive
243
272
        self.rev_id = None
244
 
        self.specific_files = specific_files
 
273
        if specific_files is not None:
 
274
            self.specific_files = sorted(
 
275
                minimum_path_selection(specific_files))
 
276
        else:
 
277
            self.specific_files = None
 
278
        self.specific_file_ids = None
245
279
        self.allow_pointless = allow_pointless
246
 
 
247
 
        if reporter is None and self.reporter is None:
248
 
            self.reporter = NullCommitReporter()
249
 
        elif reporter is not None:
250
 
            self.reporter = reporter
 
280
        self.revprops = revprops
 
281
        self.message_callback = message_callback
 
282
        self.timestamp = timestamp
 
283
        self.timezone = timezone
 
284
        self.committer = committer
 
285
        self.strict = strict
 
286
        self.verbose = verbose
251
287
 
252
288
        self.work_tree.lock_write()
253
289
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
290
        self.basis_revid = self.work_tree.last_revision()
 
291
        self.basis_tree = self.work_tree.basis_tree()
 
292
        self.basis_tree.lock_read()
254
293
        try:
255
294
            # Cannot commit with conflicts present.
256
 
            if len(self.work_tree.conflicts())>0:
 
295
            if len(self.work_tree.conflicts()) > 0:
257
296
                raise ConflictsInTree
258
297
 
259
 
            # setup the bound branch variables as needed.
260
 
            self._check_bound_branch()
261
 
 
262
 
            # check for out of date working trees
263
 
            # if we are bound, then self.branch is the master branch and this
264
 
            # test is thus all we need.
265
 
            if self.work_tree.last_revision() != self.master_branch.last_revision():
266
 
                raise errors.OutOfDateTree(self.work_tree)
267
 
    
268
 
            if strict:
269
 
                # raise an exception as soon as we find a single unknown.
270
 
                for unknown in self.work_tree.unknowns():
271
 
                    raise StrictCommitFailed()
272
 
                   
 
298
            # Setup the bound branch variables as needed.
 
299
            self._check_bound_branch(possible_master_transports)
 
300
 
 
301
            # Check that the working tree is up to date
 
302
            old_revno, new_revno = self._check_out_of_date_tree()
 
303
 
 
304
            # Complete configuration setup
 
305
            if reporter is not None:
 
306
                self.reporter = reporter
 
307
            elif self.reporter is None:
 
308
                self.reporter = self._select_reporter()
273
309
            if self.config is None:
274
310
                self.config = self.branch.get_config()
275
 
      
276
 
            if isinstance(message, str):
277
 
                message = message.decode(bzrlib.user_encoding)
278
 
            assert isinstance(message, unicode), type(message)
279
 
            self.message = message
280
 
            self._escape_commit_message()
281
 
 
282
 
            self.work_inv = self.work_tree.inventory
283
 
            self.basis_tree = self.work_tree.basis_tree()
 
311
 
 
312
            # If provided, ensure the specified files are versioned
 
313
            if self.specific_files is not None:
 
314
                # Note: This routine is being called because it raises
 
315
                # PathNotVersionedError as a side effect of finding the IDs. We
 
316
                # later use the ids we found as input to the working tree
 
317
                # inventory iterator, so we only consider those ids rather than
 
318
                # examining the whole tree again.
 
319
                # XXX: Dont we have filter_unversioned to do this more
 
320
                # cheaply?
 
321
                self.specific_file_ids = tree.find_ids_across_trees(
 
322
                    specific_files, [self.basis_tree, self.work_tree])
 
323
 
 
324
            # Setup the progress bar. As the number of files that need to be
 
325
            # committed in unknown, progress is reported as stages.
 
326
            # We keep track of entries separately though and include that
 
327
            # information in the progress bar during the relevant stages.
 
328
            self.pb_stage_name = ""
 
329
            self.pb_stage_count = 0
 
330
            self.pb_stage_total = 5
 
331
            if self.bound_branch:
 
332
                self.pb_stage_total += 1
 
333
            self.pb.show_pct = False
 
334
            self.pb.show_spinner = False
 
335
            self.pb.show_eta = False
 
336
            self.pb.show_count = True
 
337
            self.pb.show_bar = True
 
338
 
284
339
            self.basis_inv = self.basis_tree.inventory
285
 
            # one to finish, one for rev and inventory, and one for each
286
 
            # inventory entry, and the same for the new inventory.
287
 
            # note that this estimate is too long when we do a partial tree
288
 
            # commit which excludes some new files from being considered.
289
 
            # The estimate is corrected when we populate the new inv.
290
 
            self.pb_total = len(self.work_inv) + 5
291
 
            self.pb_count = 0
292
 
 
293
340
            self._gather_parents()
 
341
            # After a merge, a selected file commit is not supported.
 
342
            # See 'bzr help merge' for an explanation as to why.
294
343
            if len(self.parents) > 1 and self.specific_files:
295
 
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
296
 
                        self.specific_files)
297
 
            self._check_parents_present()
298
 
            self.builder = self.branch.get_commit_builder(self.parents, 
 
344
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
345
            # Excludes are a form of selected file commit.
 
346
            if len(self.parents) > 1 and self.exclude:
 
347
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
348
 
 
349
            # Collect the changes
 
350
            self._set_progress_stage("Collecting changes",
 
351
                    entries_title="Directory")
 
352
            self.builder = self.branch.get_commit_builder(self.parents,
299
353
                self.config, timestamp, timezone, committer, revprops, rev_id)
300
 
            
301
 
            self._remove_deleted()
302
 
            self._populate_new_inv()
303
 
            self._report_deletes()
304
 
 
305
 
            if not (self.allow_pointless
306
 
                    or len(self.parents) > 1
307
 
                    or self.builder.new_inventory != self.basis_inv):
308
 
                raise PointlessCommit()
309
 
 
310
 
            self._emit_progress_update()
311
 
            # TODO: Now the new inventory is known, check for conflicts and prompt the 
312
 
            # user for a commit message.
313
 
            self.builder.finish_inventory()
314
 
            self._emit_progress_update()
315
 
            self.rev_id = self.builder.commit(self.message)
316
 
            self._emit_progress_update()
317
 
            # revision data is in the local branch now.
318
 
            
319
 
            # upload revision data to the master.
 
354
 
 
355
            try:
 
356
                self.builder.will_record_deletes()
 
357
                # find the location being committed to
 
358
                if self.bound_branch:
 
359
                    master_location = self.master_branch.base
 
360
                else:
 
361
                    master_location = self.branch.base
 
362
 
 
363
                # report the start of the commit
 
364
                self.reporter.started(new_revno, self.rev_id, master_location)
 
365
 
 
366
                self._update_builder_with_changes()
 
367
                self._report_and_accumulate_deletes()
 
368
                self._check_pointless()
 
369
 
 
370
                # TODO: Now the new inventory is known, check for conflicts.
 
371
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
372
                # weave lines, because nothing should be recorded until it is known
 
373
                # that commit will succeed.
 
374
                self._set_progress_stage("Saving data locally")
 
375
                self.builder.finish_inventory()
 
376
 
 
377
                # Prompt the user for a commit message if none provided
 
378
                message = message_callback(self)
 
379
                self.message = message
 
380
                self._escape_commit_message()
 
381
 
 
382
                # Add revision data to the local branch
 
383
                self.rev_id = self.builder.commit(self.message)
 
384
 
 
385
            except Exception, e:
 
386
                mutter("aborting commit write group because of exception:")
 
387
                trace.log_exception_quietly()
 
388
                note("aborting commit write group: %r" % (e,))
 
389
                self.builder.abort()
 
390
                raise
 
391
 
 
392
            self._process_pre_hooks(old_revno, new_revno)
 
393
 
 
394
            # Upload revision data to the master.
320
395
            # this will propagate merged revisions too if needed.
321
396
            if self.bound_branch:
322
 
                self.master_branch.repository.fetch(self.branch.repository,
323
 
                                                    revision_id=self.rev_id)
324
 
                # now the master has the revision data
325
 
                # 'commit' to the master first so a timeout here causes the local
326
 
                # branch to be out of date
327
 
                self.master_branch.append_revision(self.rev_id)
 
397
                self._set_progress_stage("Uploading data to master branch")
 
398
                # 'commit' to the master first so a timeout here causes the
 
399
                # local branch to be out of date
 
400
                self.master_branch.import_last_revision_info(
 
401
                    self.branch.repository, new_revno, self.rev_id)
328
402
 
329
403
            # and now do the commit locally.
330
 
            self.branch.append_revision(self.rev_id)
 
404
            self.branch.set_last_revision_info(new_revno, self.rev_id)
331
405
 
332
 
            self.work_tree.set_pending_merges([])
333
 
            self.work_tree.set_last_revision(self.rev_id)
334
 
            # now the work tree is up to date with the branch
335
 
            
336
 
            self.reporter.completed(self.branch.revno(), self.rev_id)
337
 
            if self.config.post_commit() is not None:
338
 
                hooks = self.config.post_commit().split(' ')
339
 
                # this would be nicer with twisted.python.reflect.namedAny
340
 
                for hook in hooks:
341
 
                    result = eval(hook + '(branch, rev_id)',
342
 
                                  {'branch':self.branch,
343
 
                                   'bzrlib':bzrlib,
344
 
                                   'rev_id':self.rev_id})
345
 
            self._emit_progress_update()
 
406
            # Make the working tree up to date with the branch
 
407
            self._set_progress_stage("Updating the working tree")
 
408
            self.work_tree.update_basis_by_delta(self.rev_id,
 
409
                 self.builder.get_basis_delta())
 
410
            self.reporter.completed(new_revno, self.rev_id)
 
411
            self._process_post_hooks(old_revno, new_revno)
346
412
        finally:
347
413
            self._cleanup()
348
414
        return self.rev_id
349
415
 
350
 
    def _check_bound_branch(self):
 
416
    def _select_reporter(self):
 
417
        """Select the CommitReporter to use."""
 
418
        if is_quiet():
 
419
            return NullCommitReporter()
 
420
        return ReportCommitToLog()
 
421
 
 
422
    def _check_pointless(self):
 
423
        if self.allow_pointless:
 
424
            return
 
425
        # A merge with no effect on files
 
426
        if len(self.parents) > 1:
 
427
            return
 
428
        # TODO: we could simplify this by using self.builder.basis_delta.
 
429
 
 
430
        # The initial commit adds a root directory, but this in itself is not
 
431
        # a worthwhile commit.
 
432
        if (self.basis_revid == revision.NULL_REVISION and
 
433
            len(self.builder.new_inventory) == 1):
 
434
            raise PointlessCommit()
 
435
        # If length == 1, then we only have the root entry. Which means
 
436
        # that there is no real difference (only the root could be different)
 
437
        # unless deletes occured, in which case the length is irrelevant.
 
438
        if (self.any_entries_deleted or
 
439
            (len(self.builder.new_inventory) != 1 and
 
440
             self.builder.any_changes())):
 
441
            return
 
442
        raise PointlessCommit()
 
443
 
 
444
    def _check_bound_branch(self, possible_master_transports=None):
351
445
        """Check to see if the local branch is bound.
352
446
 
353
447
        If it is bound, then most of the commit will actually be
358
452
            raise errors.LocalRequiresBoundBranch()
359
453
 
360
454
        if not self.local:
361
 
            self.master_branch = self.branch.get_master_branch()
 
455
            self.master_branch = self.branch.get_master_branch(
 
456
                possible_master_transports)
362
457
 
363
458
        if not self.master_branch:
364
459
            # make this branch the reference branch for out of date checks.
375
470
        #       commits to the remote branch if they would fit.
376
471
        #       But for now, just require remote to be identical
377
472
        #       to local.
378
 
        
 
473
 
379
474
        # Make sure the local branch is identical to the master
380
 
        master_rh = self.master_branch.revision_history()
381
 
        local_rh = self.branch.revision_history()
382
 
        if local_rh != master_rh:
 
475
        master_info = self.master_branch.last_revision_info()
 
476
        local_info = self.branch.last_revision_info()
 
477
        if local_info != master_info:
383
478
            raise errors.BoundBranchOutOfDate(self.branch,
384
479
                    self.master_branch)
385
480
 
389
484
        self.master_branch.lock_write()
390
485
        self.master_locked = True
391
486
 
 
487
    def _check_out_of_date_tree(self):
 
488
        """Check that the working tree is up to date.
 
489
 
 
490
        :return: old_revision_number,new_revision_number tuple
 
491
        """
 
492
        try:
 
493
            first_tree_parent = self.work_tree.get_parent_ids()[0]
 
494
        except IndexError:
 
495
            # if there are no parents, treat our parent as 'None'
 
496
            # this is so that we still consider the master branch
 
497
            # - in a checkout scenario the tree may have no
 
498
            # parents but the branch may do.
 
499
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
500
        old_revno, master_last = self.master_branch.last_revision_info()
 
501
        if master_last != first_tree_parent:
 
502
            if master_last != bzrlib.revision.NULL_REVISION:
 
503
                raise errors.OutOfDateTree(self.work_tree)
 
504
        if self.branch.repository.has_revision(first_tree_parent):
 
505
            new_revno = old_revno + 1
 
506
        else:
 
507
            # ghost parents never appear in revision history.
 
508
            new_revno = 1
 
509
        return old_revno,new_revno
 
510
 
 
511
    def _process_pre_hooks(self, old_revno, new_revno):
 
512
        """Process any registered pre commit hooks."""
 
513
        self._set_progress_stage("Running pre_commit hooks")
 
514
        self._process_hooks("pre_commit", old_revno, new_revno)
 
515
 
 
516
    def _process_post_hooks(self, old_revno, new_revno):
 
517
        """Process any registered post commit hooks."""
 
518
        # Process the post commit hooks, if any
 
519
        self._set_progress_stage("Running post_commit hooks")
 
520
        # old style commit hooks - should be deprecated ? (obsoleted in
 
521
        # 0.15)
 
522
        if self.config.post_commit() is not None:
 
523
            hooks = self.config.post_commit().split(' ')
 
524
            # this would be nicer with twisted.python.reflect.namedAny
 
525
            for hook in hooks:
 
526
                result = eval(hook + '(branch, rev_id)',
 
527
                              {'branch':self.branch,
 
528
                               'bzrlib':bzrlib,
 
529
                               'rev_id':self.rev_id})
 
530
        # process new style post commit hooks
 
531
        self._process_hooks("post_commit", old_revno, new_revno)
 
532
 
 
533
    def _process_hooks(self, hook_name, old_revno, new_revno):
 
534
        if not Branch.hooks[hook_name]:
 
535
            return
 
536
 
 
537
        # new style commit hooks:
 
538
        if not self.bound_branch:
 
539
            hook_master = self.branch
 
540
            hook_local = None
 
541
        else:
 
542
            hook_master = self.master_branch
 
543
            hook_local = self.branch
 
544
        # With bound branches, when the master is behind the local branch,
 
545
        # the 'old_revno' and old_revid values here are incorrect.
 
546
        # XXX: FIXME ^. RBC 20060206
 
547
        if self.parents:
 
548
            old_revid = self.parents[0]
 
549
        else:
 
550
            old_revid = bzrlib.revision.NULL_REVISION
 
551
 
 
552
        if hook_name == "pre_commit":
 
553
            future_tree = self.builder.revision_tree()
 
554
            tree_delta = future_tree.changes_from(self.basis_tree,
 
555
                                             include_root=True)
 
556
 
 
557
        for hook in Branch.hooks[hook_name]:
 
558
            # show the running hook in the progress bar. As hooks may
 
559
            # end up doing nothing (e.g. because they are not configured by
 
560
            # the user) this is still showing progress, not showing overall
 
561
            # actions - its up to each plugin to show a UI if it want's to
 
562
            # (such as 'Emailing diff to foo@example.com').
 
563
            self.pb_stage_name = "Running %s hooks [%s]" % \
 
564
                (hook_name, Branch.hooks.get_hook_name(hook))
 
565
            self._emit_progress()
 
566
            if 'hooks' in debug.debug_flags:
 
567
                mutter("Invoking commit hook: %r", hook)
 
568
            if hook_name == "post_commit":
 
569
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
570
                     self.rev_id)
 
571
            elif hook_name == "pre_commit":
 
572
                hook(hook_local, hook_master,
 
573
                     old_revno, old_revid, new_revno, self.rev_id,
 
574
                     tree_delta, future_tree)
 
575
 
392
576
    def _cleanup(self):
393
577
        """Cleanup any open locks, progress bars etc."""
394
578
        cleanups = [self._cleanup_bound_branch,
 
579
                    self.basis_tree.unlock,
395
580
                    self.work_tree.unlock,
396
581
                    self.pb.finished]
397
582
        found_exception = None
404
589
            # typically this will be useful enough.
405
590
            except Exception, e:
406
591
                found_exception = e
407
 
        if found_exception is not None: 
 
592
        if found_exception is not None:
408
593
            # don't do a plan raise, because the last exception may have been
409
594
            # trashed, e is our sure-to-work exception even though it loses the
410
595
            # full traceback. XXX: RBC 20060421 perhaps we could check the
411
 
            # exc_info and if its the same one do a plain raise otherwise 
 
596
            # exc_info and if its the same one do a plain raise otherwise
412
597
            # 'raise e' as we do now.
413
598
            raise e
414
599
 
430
615
        # serialiser not by commit. Then we can also add an unescaper
431
616
        # in the deserializer and start roundtripping revision messages
432
617
        # precisely. See repository_implementations/test_repository.py
433
 
        
 
618
 
434
619
        # Python strings can include characters that can't be
435
620
        # represented in well-formed XML; escape characters that
436
621
        # aren't listed in the XML specification
444
629
 
445
630
    def _gather_parents(self):
446
631
        """Record the parents of a merge for merge detection."""
447
 
        # TODO: Make sure that this list doesn't contain duplicate 
 
632
        # TODO: Make sure that this list doesn't contain duplicate
448
633
        # entries and the order is preserved when doing this.
449
634
        self.parents = self.work_tree.get_parent_ids()
450
 
        self.parent_invs = []
451
 
        for revision in self.parents:
 
635
        self.parent_invs = [self.basis_inv]
 
636
        for revision in self.parents[1:]:
452
637
            if self.branch.repository.has_revision(revision):
 
638
                mutter('commit parent revision {%s}', revision)
453
639
                inventory = self.branch.repository.get_inventory(revision)
454
640
                self.parent_invs.append(inventory)
455
 
 
456
 
    def _check_parents_present(self):
457
 
        for parent_id in self.parents:
458
 
            mutter('commit parent revision {%s}', parent_id)
459
 
            if not self.branch.repository.has_revision(parent_id):
460
 
                if parent_id == self.branch.last_revision():
461
 
                    warning("parent is missing %r", parent_id)
462
 
                    raise BzrCheckError("branch %s is missing revision {%s}"
463
 
                            % (self.branch, parent_id))
464
 
            
465
 
    def _remove_deleted(self):
466
 
        """Remove deleted files from the working inventories.
467
 
 
468
 
        This is done prior to taking the working inventory as the
469
 
        basis for the new committed inventory.
470
 
 
471
 
        This returns true if any files
472
 
        *that existed in the basis inventory* were deleted.
473
 
        Files that were added and deleted
474
 
        in the working copy don't matter.
475
 
        """
476
 
        specific = self.specific_files
477
 
        deleted_ids = []
478
 
        for path, ie in self.work_inv.iter_entries():
479
 
            if specific and not is_inside_any(specific, path):
480
 
                continue
481
 
            if not self.work_tree.has_filename(path):
482
 
                self.reporter.missing(path)
483
 
                deleted_ids.append((path, ie.file_id))
484
 
        if deleted_ids:
485
 
            deleted_ids.sort(reverse=True)
486
 
            for path, file_id in deleted_ids:
487
 
                del self.work_inv[file_id]
488
 
            self.work_tree._write_inventory(self.work_inv)
489
 
 
490
 
    def _populate_new_inv(self):
491
 
        """Build revision inventory.
492
 
 
493
 
        This creates a new empty inventory. Depending on
494
 
        which files are selected for commit, and what is present in the
495
 
        current tree, the new inventory is populated. inventory entries 
496
 
        which are candidates for modification have their revision set to
497
 
        None; inventory entries that are carried over untouched have their
498
 
        revision set to their prior value.
499
 
        """
 
641
            else:
 
642
                mutter('commit parent ghost revision {%s}', revision)
 
643
 
 
644
    def _update_builder_with_changes(self):
 
645
        """Update the commit builder with the data about what has changed.
 
646
        """
 
647
        # Build the revision inventory.
 
648
        #
 
649
        # This starts by creating a new empty inventory. Depending on
 
650
        # which files are selected for commit, and what is present in the
 
651
        # current tree, the new inventory is populated. inventory entries
 
652
        # which are candidates for modification have their revision set to
 
653
        # None; inventory entries that are carried over untouched have their
 
654
        # revision set to their prior value.
 
655
        #
500
656
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
501
657
        # results to create a new inventory at the same time, which results
502
658
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
503
659
        # ADHB 11-07-2006
504
 
        mutter("Selecting files for commit with filter %s", self.specific_files)
505
 
        # at this point we dont copy the root entry:
506
 
        entries = self.work_inv.iter_entries()
507
 
        entries.next()
508
 
        self._emit_progress_update()
509
 
        for path, new_ie in entries:
510
 
            self._emit_progress_update()
511
 
            file_id = new_ie.file_id
512
 
            # mutter('check %s {%s}', path, file_id)
513
 
            if (not self.specific_files or 
514
 
                is_inside_or_parent_of_any(self.specific_files, path)):
515
 
                    # mutter('%s selected for commit', path)
516
 
                    ie = new_ie.copy()
 
660
 
 
661
        exclude = self.exclude
 
662
        specific_files = self.specific_files or []
 
663
        mutter("Selecting files for commit with filter %s", specific_files)
 
664
 
 
665
        # Build the new inventory
 
666
        self._populate_from_inventory()
 
667
 
 
668
        # If specific files are selected, then all un-selected files must be
 
669
        # recorded in their previous state. For more details, see
 
670
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
671
        if specific_files or exclude:
 
672
            for path, old_ie in self.basis_inv.iter_entries():
 
673
                if old_ie.file_id in self.builder.new_inventory:
 
674
                    # already added - skip.
 
675
                    continue
 
676
                if (is_inside_any(specific_files, path)
 
677
                    and not is_inside_any(exclude, path)):
 
678
                    # was inside the selected path, and not excluded - if not
 
679
                    # present it has been deleted so skip.
 
680
                    continue
 
681
                # From here down it was either not selected, or was excluded:
 
682
                if old_ie.kind == 'directory':
 
683
                    self._next_progress_entry()
 
684
                # We preserve the entry unaltered.
 
685
                ie = old_ie.copy()
 
686
                # Note: specific file commits after a merge are currently
 
687
                # prohibited. This test is for sanity/safety in case it's
 
688
                # required after that changes.
 
689
                if len(self.parents) > 1:
517
690
                    ie.revision = None
518
 
            else:
519
 
                # mutter('%s not selected for commit', path)
520
 
                if self.basis_inv.has_id(file_id):
521
 
                    ie = self.basis_inv[file_id].copy()
522
 
                else:
523
 
                    # this entry is new and not being committed
524
 
                    continue
525
 
 
526
 
            self.builder.record_entry_contents(ie, self.parent_invs, 
527
 
                path, self.work_tree)
528
 
            # describe the nature of the change that has occurred relative to
529
 
            # the basis inventory.
530
 
            if (self.basis_inv.has_id(ie.file_id)):
531
 
                basis_ie = self.basis_inv[ie.file_id]
532
 
            else:
533
 
                basis_ie = None
534
 
            change = ie.describe_change(basis_ie, ie)
535
 
            if change in (InventoryEntry.RENAMED, 
536
 
                InventoryEntry.MODIFIED_AND_RENAMED):
537
 
                old_path = self.basis_inv.id2path(ie.file_id)
538
 
                self.reporter.renamed(change, old_path, path)
539
 
            else:
540
 
                self.reporter.snapshot_change(change, path)
541
 
 
542
 
        if not self.specific_files:
543
 
            return
544
 
 
545
 
        # ignore removals that don't match filespec
546
 
        for path, new_ie in self.basis_inv.iter_entries():
547
 
            if new_ie.file_id in self.work_inv:
548
 
                continue
549
 
            if is_inside_any(self.specific_files, path):
550
 
                continue
551
 
            ie = new_ie.copy()
 
691
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
692
                    self.basis_tree, None)
 
693
 
 
694
    def _report_and_accumulate_deletes(self):
 
695
        # XXX: Could the list of deleted paths and ids be instead taken from
 
696
        # _populate_from_inventory?
 
697
        if (isinstance(self.basis_inv, Inventory)
 
698
            and isinstance(self.builder.new_inventory, Inventory)):
 
699
            # the older Inventory classes provide a _byid dict, and building a
 
700
            # set from the keys of this dict is substantially faster than even
 
701
            # getting a set of ids from the inventory
 
702
            #
 
703
            # <lifeless> set(dict) is roughly the same speed as
 
704
            # set(iter(dict)) and both are significantly slower than
 
705
            # set(dict.keys())
 
706
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
707
               set(self.builder.new_inventory._byid.keys())
 
708
        else:
 
709
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
710
        if deleted_ids:
 
711
            self.any_entries_deleted = True
 
712
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
713
                for file_id in deleted_ids]
 
714
            deleted.sort()
 
715
            # XXX: this is not quite directory-order sorting
 
716
            for path, file_id in deleted:
 
717
                self.builder.record_delete(path, file_id)
 
718
                self.reporter.deleted(path)
 
719
 
 
720
    def _populate_from_inventory(self):
 
721
        """Populate the CommitBuilder by walking the working tree inventory."""
 
722
        if self.strict:
 
723
            # raise an exception as soon as we find a single unknown.
 
724
            for unknown in self.work_tree.unknowns():
 
725
                raise StrictCommitFailed()
 
726
 
 
727
        specific_files = self.specific_files
 
728
        exclude = self.exclude
 
729
        report_changes = self.reporter.is_verbose()
 
730
        deleted_ids = []
 
731
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
732
        # deleted, then we have {'foo':{'bar':{}}}
 
733
        deleted_paths = {}
 
734
        # XXX: Note that entries may have the wrong kind because the entry does
 
735
        # not reflect the status on disk.
 
736
        work_inv = self.work_tree.inventory
 
737
        # NB: entries will include entries within the excluded ids/paths
 
738
        # because iter_entries_by_dir has no 'exclude' facility today.
 
739
        entries = work_inv.iter_entries_by_dir(
 
740
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
741
        for path, existing_ie in entries:
 
742
            file_id = existing_ie.file_id
 
743
            name = existing_ie.name
 
744
            parent_id = existing_ie.parent_id
 
745
            kind = existing_ie.kind
 
746
            if kind == 'directory':
 
747
                self._next_progress_entry()
 
748
            # Skip files that have been deleted from the working tree.
 
749
            # The deleted path ids are also recorded so they can be explicitly
 
750
            # unversioned later.
 
751
            if deleted_paths:
 
752
                path_segments = splitpath(path)
 
753
                deleted_dict = deleted_paths
 
754
                for segment in path_segments:
 
755
                    deleted_dict = deleted_dict.get(segment, None)
 
756
                    if not deleted_dict:
 
757
                        # We either took a path not present in the dict
 
758
                        # (deleted_dict was None), or we've reached an empty
 
759
                        # child dir in the dict, so are now a sub-path.
 
760
                        break
 
761
                else:
 
762
                    deleted_dict = None
 
763
                if deleted_dict is not None:
 
764
                    # the path has a deleted parent, do not add it.
 
765
                    continue
 
766
            if exclude and is_inside_any(exclude, path):
 
767
                # Skip excluded paths. Excluded paths are processed by
 
768
                # _update_builder_with_changes.
 
769
                continue
 
770
            content_summary = self.work_tree.path_content_summary(path)
 
771
            # Note that when a filter of specific files is given, we must only
 
772
            # skip/record deleted files matching that filter.
 
773
            if not specific_files or is_inside_any(specific_files, path):
 
774
                if content_summary[0] == 'missing':
 
775
                    if not deleted_paths:
 
776
                        # path won't have been split yet.
 
777
                        path_segments = splitpath(path)
 
778
                    deleted_dict = deleted_paths
 
779
                    for segment in path_segments:
 
780
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
781
                    self.reporter.missing(path)
 
782
                    deleted_ids.append(file_id)
 
783
                    continue
 
784
            # TODO: have the builder do the nested commit just-in-time IF and
 
785
            # only if needed.
 
786
            if content_summary[0] == 'tree-reference':
 
787
                # enforce repository nested tree policy.
 
788
                if (not self.work_tree.supports_tree_reference() or
 
789
                    # repository does not support it either.
 
790
                    not self.branch.repository._format.supports_tree_reference):
 
791
                    content_summary = ('directory',) + content_summary[1:]
 
792
            kind = content_summary[0]
 
793
            # TODO: specific_files filtering before nested tree processing
 
794
            if kind == 'tree-reference':
 
795
                if self.recursive == 'down':
 
796
                    nested_revision_id = self._commit_nested_tree(
 
797
                        file_id, path)
 
798
                    content_summary = content_summary[:3] + (
 
799
                        nested_revision_id,)
 
800
                else:
 
801
                    content_summary = content_summary[:3] + (
 
802
                        self.work_tree.get_reference_revision(file_id),)
 
803
 
 
804
            # Record an entry for this item
 
805
            # Note: I don't particularly want to have the existing_ie
 
806
            # parameter but the test suite currently (28-Jun-07) breaks
 
807
            # without it thanks to a unicode normalisation issue. :-(
 
808
            definitely_changed = kind != existing_ie.kind
 
809
            self._record_entry(path, file_id, specific_files, kind, name,
 
810
                parent_id, definitely_changed, existing_ie, report_changes,
 
811
                content_summary)
 
812
 
 
813
        # Unversion IDs that were found to be deleted
 
814
        self.work_tree.unversion(deleted_ids)
 
815
 
 
816
    def _commit_nested_tree(self, file_id, path):
 
817
        "Commit a nested tree."
 
818
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
 
819
        # FIXME: be more comprehensive here:
 
820
        # this works when both trees are in --trees repository,
 
821
        # but when both are bound to a different repository,
 
822
        # it fails; a better way of approaching this is to
 
823
        # finally implement the explicit-caches approach design
 
824
        # a while back - RBC 20070306.
 
825
        if sub_tree.branch.repository.has_same_location(
 
826
            self.work_tree.branch.repository):
 
827
            sub_tree.branch.repository = \
 
828
                self.work_tree.branch.repository
 
829
        try:
 
830
            return sub_tree.commit(message=None, revprops=self.revprops,
 
831
                recursive=self.recursive,
 
832
                message_callback=self.message_callback,
 
833
                timestamp=self.timestamp, timezone=self.timezone,
 
834
                committer=self.committer,
 
835
                allow_pointless=self.allow_pointless,
 
836
                strict=self.strict, verbose=self.verbose,
 
837
                local=self.local, reporter=self.reporter)
 
838
        except errors.PointlessCommit:
 
839
            return self.work_tree.get_reference_revision(file_id)
 
840
 
 
841
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
842
        parent_id, definitely_changed, existing_ie, report_changes,
 
843
        content_summary):
 
844
        "Record the new inventory entry for a path if any."
 
845
        # mutter('check %s {%s}', path, file_id)
 
846
        # mutter('%s selected for commit', path)
 
847
        if definitely_changed or existing_ie is None:
 
848
            ie = make_entry(kind, name, parent_id, file_id)
 
849
        else:
 
850
            ie = existing_ie.copy()
552
851
            ie.revision = None
553
 
            self.builder.record_entry_contents(ie, self.parent_invs, path,
554
 
                                               self.basis_tree)
555
 
 
556
 
    def _emit_progress_update(self):
557
 
        """Emit an update to the progress bar."""
558
 
        self.pb.update("Committing", self.pb_count, self.pb_total)
559
 
        self.pb_count += 1
560
 
 
561
 
    def _report_deletes(self):
562
 
        for path, ie in self.basis_inv.iter_entries():
563
 
            if ie.file_id not in self.builder.new_inventory:
564
 
                self.reporter.deleted(path)
565
 
 
 
852
        # For carried over entries we don't care about the fs hash - the repo
 
853
        # isn't generating a sha, so we're not saving computation time.
 
854
        _, _, fs_hash = self.builder.record_entry_contents(
 
855
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
856
        if report_changes:
 
857
            self._report_change(ie, path)
 
858
        if fs_hash:
 
859
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
860
        return ie
 
861
 
 
862
    def _report_change(self, ie, path):
 
863
        """Report a change to the user.
 
864
 
 
865
        The change that has occurred is described relative to the basis
 
866
        inventory.
 
867
        """
 
868
        if (self.basis_inv.has_id(ie.file_id)):
 
869
            basis_ie = self.basis_inv[ie.file_id]
 
870
        else:
 
871
            basis_ie = None
 
872
        change = ie.describe_change(basis_ie, ie)
 
873
        if change in (InventoryEntry.RENAMED,
 
874
            InventoryEntry.MODIFIED_AND_RENAMED):
 
875
            old_path = self.basis_inv.id2path(ie.file_id)
 
876
            self.reporter.renamed(change, old_path, path)
 
877
        else:
 
878
            self.reporter.snapshot_change(change, path)
 
879
 
 
880
    def _set_progress_stage(self, name, entries_title=None):
 
881
        """Set the progress stage and emit an update to the progress bar."""
 
882
        self.pb_stage_name = name
 
883
        self.pb_stage_count += 1
 
884
        self.pb_entries_title = entries_title
 
885
        if entries_title is not None:
 
886
            self.pb_entries_count = 0
 
887
            self.pb_entries_total = '?'
 
888
        self._emit_progress()
 
889
 
 
890
    def _next_progress_entry(self):
 
891
        """Emit an update to the progress bar and increment the entry count."""
 
892
        self.pb_entries_count += 1
 
893
        self._emit_progress()
 
894
 
 
895
    def _emit_progress(self):
 
896
        if self.pb_entries_title:
 
897
            if self.pb_entries_total == '?':
 
898
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
899
                    self.pb_entries_title, self.pb_entries_count)
 
900
            else:
 
901
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
902
                    self.pb_entries_title, self.pb_entries_count,
 
903
                    str(self.pb_entries_total))
 
904
        else:
 
905
            text = "%s - Stage" % (self.pb_stage_name)
 
906
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
566
907