/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

[merge] (Goffredo) faster merge/fetch by peeking into weave

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
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?)
16
27
 
17
28
# The newly committed revision is going to have a shape corresponding
18
 
# to that of the working tree.  Files that are not in the
 
29
# to that of the working inventory.  Files that are not in the
19
30
# working tree and that were in the predecessor are reported as
20
31
# removed --- this can include files that were either removed from the
21
32
# inventory or deleted in the working tree.  If they were only
24
35
# We then consider the remaining entries, which will be in the new
25
36
# version.  Directory entries are simply copied across.  File entries
26
37
# must be checked to see if a new version of the file should be
27
 
# recorded.  For each parent revision tree, we check to see what
 
38
# recorded.  For each parent revision inventory, we check to see what
28
39
# version of the file was present.  If the file was present in at
29
40
# least one tree, and if it was the same version in all the trees,
30
41
# then we can just refer to that version.  Otherwise, a new version
45
56
# merges from, then it should still be reported as newly added
46
57
# relative to the basis revision.
47
58
 
48
 
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
49
 
# the rest of the code; add a deprecation of the old name.
50
 
 
51
 
from . import (
52
 
    debug,
53
 
    errors,
54
 
    trace,
55
 
    ui,
56
 
    )
57
 
from .branch import Branch
58
 
from contextlib import ExitStack
59
 
import breezy.config
60
 
from .errors import (BzrError,
61
 
                     ConflictsInTree,
62
 
                     StrictCommitFailed
63
 
                     )
64
 
from .osutils import (get_user_encoding,
65
 
                      has_symlinks,
66
 
                      is_inside_any,
67
 
                      minimum_path_selection,
68
 
                      )
69
 
from .trace import mutter, note, is_quiet
70
 
from .tree import TreeChange
71
 
from .urlutils import unescape_for_display
72
 
from .i18n import gettext
73
 
 
74
 
 
75
 
class PointlessCommit(BzrError):
76
 
 
77
 
    _fmt = "No changes to commit"
78
 
 
79
 
 
80
 
class CannotCommitSelectedFileMerge(BzrError):
81
 
 
82
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
83
 
        ' files %(files_str)s'
84
 
 
85
 
    def __init__(self, files):
86
 
        files_str = ', '.join(files)
87
 
        BzrError.__init__(self, files=files, files_str=files_str)
88
 
 
89
 
 
90
 
def filter_excluded(iter_changes, exclude):
91
 
    """Filter exclude filenames.
92
 
 
93
 
    :param iter_changes: iter_changes function
94
 
    :param exclude: List of paths to exclude
95
 
    :return: iter_changes function
 
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
 
 
65
 
 
66
import os
 
67
import re
 
68
import sys
 
69
import time
 
70
import pdb
 
71
 
 
72
from binascii import hexlify
 
73
from cStringIO import StringIO
 
74
 
 
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_string, sha_strings, sha_file, isdir, isfile,
 
80
                            split_lines)
 
81
import bzrlib.config
 
82
from bzrlib.errors import (BzrError, PointlessCommit,
 
83
                           HistoryMissing,
 
84
                           ConflictsInTree,
 
85
                           StrictCommitFailed
 
86
                           )
 
87
import bzrlib.gpg as gpg
 
88
from bzrlib.revision import Revision
 
89
from bzrlib.testament import Testament
 
90
from bzrlib.trace import mutter, note, warning
 
91
from bzrlib.xml5 import serializer_v5
 
92
from bzrlib.inventory import Inventory, ROOT_ID
 
93
from bzrlib.weave import Weave
 
94
from bzrlib.weavefile import read_weave, write_weave_v5
 
95
from bzrlib.workingtree import WorkingTree
 
96
 
 
97
 
 
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.
96
104
    """
97
 
    for change in iter_changes:
98
 
        new_excluded = (change.path[1] is not None and
99
 
                        is_inside_any(exclude, change.path[1]))
100
 
 
101
 
        old_excluded = (change.path[0] is not None and
102
 
                        is_inside_any(exclude, change.path[0]))
103
 
 
104
 
        if old_excluded and new_excluded:
105
 
            continue
106
 
 
107
 
        if old_excluded or new_excluded:
108
 
            # TODO(jelmer): Perhaps raise an error here instead?
109
 
            continue
110
 
 
111
 
        yield change
 
105
    ## XXX: Remove this in favor of Branch.commit?
 
106
    Commit().commit(*args, **kwargs)
112
107
 
113
108
 
114
109
class NullCommitReporter(object):
115
110
    """I report on progress of a commit."""
116
111
 
117
 
    def started(self, revno, revid, location):
118
 
        pass
119
 
 
120
112
    def snapshot_change(self, change, path):
121
113
        pass
122
114
 
123
115
    def completed(self, revno, rev_id):
124
116
        pass
125
117
 
126
 
    def deleted(self, path):
 
118
    def deleted(self, file_id):
 
119
        pass
 
120
 
 
121
    def escaped(self, escape_count, message):
127
122
        pass
128
123
 
129
124
    def missing(self, path):
130
125
        pass
131
126
 
132
 
    def renamed(self, change, old_path, new_path):
133
 
        pass
134
 
 
135
 
    def is_verbose(self):
136
 
        return False
137
 
 
138
127
 
139
128
class ReportCommitToLog(NullCommitReporter):
140
129
 
141
 
    def _note(self, format, *args):
142
 
        """Output a message.
143
 
 
144
 
        Subclasses may choose to override this method.
145
 
        """
146
 
        note(format, *args)
147
 
 
148
130
    def snapshot_change(self, change, path):
149
 
        if path == '' and change in (gettext('added'), gettext('modified')):
150
 
            return
151
 
        self._note("%s %s", change, path)
152
 
 
153
 
    def started(self, revno, rev_id, location):
154
 
        self._note(
155
 
            gettext('Committing to: %s'),
156
 
            unescape_for_display(location, 'utf-8'))
 
131
        note("%s %s", change, path)
157
132
 
158
133
    def completed(self, revno, rev_id):
159
 
        if revno is not None:
160
 
            self._note(gettext('Committed revision %d.'), revno)
161
 
            # self._note goes to the console too; so while we want to log the
162
 
            # rev_id, we can't trivially only log it. (See bug 526425). Long
163
 
            # term we should rearrange the reporting structure, but for now
164
 
            # we just mutter seperately. We mutter the revid and revno together
165
 
            # so that concurrent bzr invocations won't lead to confusion.
166
 
            mutter('Committed revid %s as revno %d.', rev_id, revno)
167
 
        else:
168
 
            self._note(gettext('Committed revid %s.'), rev_id)
 
134
        note('committed r%d {%s}', revno, rev_id)
 
135
    
 
136
    def deleted(self, file_id):
 
137
        note('deleted %s', file_id)
169
138
 
170
 
    def deleted(self, path):
171
 
        self._note(gettext('deleted %s'), path)
 
139
    def escaped(self, escape_count, message):
 
140
        note("replaced %d control characters in message", escape_count)
172
141
 
173
142
    def missing(self, path):
174
 
        self._note(gettext('missing %s'), path)
175
 
 
176
 
    def renamed(self, change, old_path, new_path):
177
 
        self._note('%s %s => %s', change, old_path, new_path)
178
 
 
179
 
    def is_verbose(self):
180
 
        return True
 
143
        note('missing %s', path)
181
144
 
182
145
 
183
146
class Commit(object):
192
155
            the working directory; these should be removed from the
193
156
            working inventory.
194
157
    """
195
 
 
196
158
    def __init__(self,
197
159
                 reporter=None,
198
 
                 config_stack=None):
199
 
        """Create a Commit object.
200
 
 
201
 
        :param reporter: the default reporter to use or None to decide later
202
 
        """
203
 
        self.reporter = reporter
204
 
        self.config_stack = config_stack
205
 
 
206
 
    @staticmethod
207
 
    def update_revprops(revprops, branch, authors=None,
208
 
                        local=False, possible_master_transports=None):
209
 
        if revprops is None:
210
 
            revprops = {}
211
 
        if possible_master_transports is None:
212
 
            possible_master_transports = []
213
 
        if (u'branch-nick' not in revprops and
214
 
                branch.repository._format.supports_storing_branch_nick):
215
 
            revprops[u'branch-nick'] = branch._get_nick(
216
 
                local,
217
 
                possible_master_transports)
218
 
        if authors is not None:
219
 
            if u'author' in revprops or u'authors' in revprops:
220
 
                # XXX: maybe we should just accept one of them?
221
 
                raise AssertionError('author property given twice')
222
 
            if authors:
223
 
                for individual in authors:
224
 
                    if '\n' in individual:
225
 
                        raise AssertionError('\\n is not a valid character '
226
 
                                             'in an author identity')
227
 
                revprops[u'authors'] = '\n'.join(authors)
228
 
        return revprops
229
 
 
 
160
                 config=None):
 
161
        if reporter is not None:
 
162
            self.reporter = reporter
 
163
        else:
 
164
            self.reporter = NullCommitReporter()
 
165
        if config is not None:
 
166
            self.config = config
 
167
        else:
 
168
            self.config = None
 
169
        
230
170
    def commit(self,
231
 
               message=None,
 
171
               branch, message,
232
172
               timestamp=None,
233
173
               timezone=None,
234
174
               committer=None,
237
177
               allow_pointless=True,
238
178
               strict=False,
239
179
               verbose=False,
240
 
               revprops=None,
241
 
               working_tree=None,
242
 
               local=False,
243
 
               reporter=None,
244
 
               config=None,
245
 
               message_callback=None,
246
 
               recursive='down',
247
 
               exclude=None,
248
 
               possible_master_transports=None,
249
 
               lossy=False):
 
180
               revprops=None):
250
181
        """Commit working copy as a new revision.
251
182
 
252
 
        :param message: the commit message (it or message_callback is required)
253
 
        :param message_callback: A callback: message =
254
 
            message_callback(cmt_obj)
255
 
 
256
 
        :param timestamp: if not None, seconds-since-epoch for a
257
 
            postdated/predated commit.
258
 
 
259
 
        :param specific_files: If not None, commit only those files. An empty
260
 
            list means 'commit no files'.
261
 
 
262
 
        :param rev_id: If set, use this as the new revision id.
 
183
        timestamp -- if not None, seconds-since-epoch for a
 
184
             postdated/predated commit.
 
185
 
 
186
        specific_files -- If true, commit only those files.
 
187
 
 
188
        rev_id -- If set, use this as the new revision id.
263
189
            Useful for test or import commands that need to tightly
264
190
            control what revisions are assigned.  If you duplicate
265
191
            a revision id that exists elsewhere it is your own fault.
266
192
            If null (default), a time/random revision id is generated.
267
193
 
268
 
        :param allow_pointless: If true (default), commit even if nothing
 
194
        allow_pointless -- If true (default), commit even if nothing
269
195
            has changed and no merges are recorded.
270
196
 
271
 
        :param strict: If true, don't allow a commit if the working tree
 
197
        strict -- If true, don't allow a commit if the working tree
272
198
            contains unknown files.
273
199
 
274
 
        :param revprops: Properties for new revision
275
 
        :param local: Perform a local only commit.
276
 
        :param reporter: the reporter to use or None for the default
277
 
        :param verbose: if True and the reporter is not None, report everything
278
 
        :param recursive: If set to 'down', commit in any subtrees that have
279
 
            pending changes of any sort during this commit.
280
 
        :param exclude: None or a list of relative paths to exclude from the
281
 
            commit. Pending changes to excluded files will be ignored by the
282
 
            commit.
283
 
        :param lossy: When committing to a foreign VCS, ignore any
284
 
            data that can not be natively represented.
 
200
        revprops -- Properties for new revision
285
201
        """
286
 
        with ExitStack() as stack:
287
 
            self.revprops = revprops or {}
288
 
            # XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
 
            self.config_stack = config or self.config_stack
290
 
            mutter('preparing to commit')
291
 
 
292
 
            if working_tree is None:
293
 
                raise BzrError("working_tree must be passed into commit().")
294
 
            else:
295
 
                self.work_tree = working_tree
296
 
                self.branch = self.work_tree.branch
297
 
                if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
298
 
                    if not self.branch.repository.supports_rich_root():
299
 
                        raise errors.RootNotRich()
300
 
            if message_callback is None:
301
 
                if message is not None:
302
 
                    if isinstance(message, bytes):
303
 
                        message = message.decode(get_user_encoding())
304
 
 
305
 
                    def message_callback(x):
306
 
                        return message
307
 
                else:
308
 
                    raise BzrError("The message or message_callback keyword"
309
 
                                   " parameter is required for commit().")
310
 
 
311
 
            self.bound_branch = None
312
 
            self.any_entries_deleted = False
313
 
            if exclude is not None:
314
 
                self.exclude = sorted(
315
 
                    minimum_path_selection(exclude))
316
 
            else:
317
 
                self.exclude = []
318
 
            self.local = local
319
 
            self.master_branch = None
320
 
            self.recursive = recursive
321
 
            self.rev_id = None
322
 
            # self.specific_files is None to indicate no filter, or any iterable to
323
 
            # indicate a filter - [] means no files at all, as per iter_changes.
324
 
            if specific_files is not None:
325
 
                self.specific_files = sorted(
326
 
                    minimum_path_selection(specific_files))
327
 
            else:
328
 
                self.specific_files = None
329
 
 
330
 
            self.allow_pointless = allow_pointless
331
 
            self.message_callback = message_callback
332
 
            self.timestamp = timestamp
333
 
            self.timezone = timezone
 
202
        mutter('preparing to commit')
 
203
 
 
204
        self.branch = branch
 
205
        self.weave_store = branch.weave_store
 
206
        self.rev_id = rev_id
 
207
        self.specific_files = specific_files
 
208
        self.allow_pointless = allow_pointless
 
209
        self.revprops = {'branch-nick': branch.nick}
 
210
        if revprops:
 
211
            self.revprops.update(revprops)
 
212
        self.work_tree = WorkingTree(branch.base, branch)
 
213
 
 
214
        if strict:
 
215
            # raise an exception as soon as we find a single unknown.
 
216
            for unknown in self.work_tree.unknowns():
 
217
                raise StrictCommitFailed()
 
218
 
 
219
        if timestamp is None:
 
220
            self.timestamp = time.time()
 
221
        else:
 
222
            self.timestamp = long(timestamp)
 
223
            
 
224
        if self.config is None:
 
225
            self.config = bzrlib.config.BranchConfig(self.branch)
 
226
 
 
227
        if rev_id is None:
 
228
            self.rev_id = _gen_revision_id(self.config, self.timestamp)
 
229
        else:
 
230
            self.rev_id = rev_id
 
231
 
 
232
        if committer is None:
 
233
            self.committer = self.config.username()
 
234
        else:
 
235
            assert isinstance(committer, basestring), type(committer)
334
236
            self.committer = committer
335
 
            self.strict = strict
336
 
            self.verbose = verbose
337
 
 
338
 
            stack.enter_context(self.work_tree.lock_write())
339
 
            self.parents = self.work_tree.get_parent_ids()
340
 
            self.pb = ui.ui_factory.nested_progress_bar()
341
 
            stack.callback(self.pb.finished)
342
 
            self.basis_revid = self.work_tree.last_revision()
343
 
            self.basis_tree = self.work_tree.basis_tree()
344
 
            stack.enter_context(self.basis_tree.lock_read())
345
 
            # Cannot commit with conflicts present.
346
 
            if len(self.work_tree.conflicts()) > 0:
 
237
 
 
238
        if timezone is None:
 
239
            self.timezone = local_time_offset()
 
240
        else:
 
241
            self.timezone = int(timezone)
 
242
 
 
243
        if isinstance(message, str):
 
244
            message = message.decode(bzrlib.user_encoding)
 
245
        assert isinstance(message, unicode), type(message)
 
246
        self.message = message
 
247
        self._escape_commit_message()
 
248
 
 
249
        self.branch.lock_write()
 
250
        try:
 
251
            self.work_inv = self.work_tree.inventory
 
252
            self.basis_tree = self.branch.basis_tree()
 
253
            self.basis_inv = self.basis_tree.inventory
 
254
 
 
255
            self._gather_parents()
 
256
            if len(self.parents) > 1 and self.specific_files:
 
257
                raise NotImplementedError('selected-file commit of merges is not supported yet')
 
258
            self._check_parents_present()
 
259
            
 
260
            self._remove_deleted()
 
261
            self._populate_new_inv()
 
262
            self._store_snapshot()
 
263
            self._report_deletes()
 
264
 
 
265
            if not (self.allow_pointless
 
266
                    or len(self.parents) > 1
 
267
                    or self.new_inv != self.basis_inv):
 
268
                raise PointlessCommit()
 
269
 
 
270
            if len(list(self.work_tree.iter_conflicts()))>0:
347
271
                raise ConflictsInTree
348
272
 
349
 
            # Setup the bound branch variables as needed.
350
 
            self._check_bound_branch(stack, possible_master_transports)
351
 
            if self.config_stack is None:
352
 
                self.config_stack = self.work_tree.get_config_stack()
353
 
 
354
 
            # Check that the working tree is up to date
355
 
            old_revno, old_revid, new_revno = self._check_out_of_date_tree()
356
 
 
357
 
            # Complete configuration setup
358
 
            if reporter is not None:
359
 
                self.reporter = reporter
360
 
            elif self.reporter is None:
361
 
                self.reporter = self._select_reporter()
362
 
 
363
 
            # Setup the progress bar. As the number of files that need to be
364
 
            # committed in unknown, progress is reported as stages.
365
 
            # We keep track of entries separately though and include that
366
 
            # information in the progress bar during the relevant stages.
367
 
            self.pb_stage_name = ""
368
 
            self.pb_stage_count = 0
369
 
            self.pb_stage_total = 5
370
 
            if self.bound_branch:
371
 
                # 2 extra stages: "Uploading data to master branch" and "Merging
372
 
                # tags to master branch"
373
 
                self.pb_stage_total += 2
374
 
            self.pb.show_pct = False
375
 
            self.pb.show_spinner = False
376
 
            self.pb.show_eta = False
377
 
            self.pb.show_count = True
378
 
            self.pb.show_bar = True
379
 
 
380
 
            # After a merge, a selected file commit is not supported.
381
 
            # See 'bzr help merge' for an explanation as to why.
382
 
            if len(self.parents) > 1 and self.specific_files is not None:
383
 
                raise CannotCommitSelectedFileMerge(self.specific_files)
384
 
            # Excludes are a form of selected file commit.
385
 
            if len(self.parents) > 1 and self.exclude:
386
 
                raise CannotCommitSelectedFileMerge(self.exclude)
387
 
 
388
 
            # Collect the changes
389
 
            self._set_progress_stage("Collecting changes", counter=True)
390
 
            self._lossy = lossy
391
 
            self.builder = self.branch.get_commit_builder(
392
 
                self.parents, self.config_stack, timestamp, timezone, committer,
393
 
                self.revprops, rev_id, lossy=lossy)
394
 
 
395
 
            if self.builder.updates_branch and self.bound_branch:
396
 
                self.builder.abort()
397
 
                raise AssertionError(
398
 
                    "bound branches not supported for commit builders "
399
 
                    "that update the branch")
400
 
 
401
 
            try:
402
 
                # find the location being committed to
403
 
                if self.bound_branch:
404
 
                    master_location = self.master_branch.base
 
273
            self._record_inventory()
 
274
            self._make_revision()
 
275
            self.work_tree.set_pending_merges([])
 
276
            self.branch.append_revision(self.rev_id)
 
277
            self.reporter.completed(self.branch.revno()+1, self.rev_id)
 
278
            if self.config.post_commit() is not None:
 
279
                hooks = self.config.post_commit().split(' ')
 
280
                # this would be nicer with twisted.python.reflect.namedAny
 
281
                for hook in hooks:
 
282
                    result = eval(hook + '(branch, rev_id)',
 
283
                                  {'branch':self.branch,
 
284
                                   'bzrlib':bzrlib,
 
285
                                   'rev_id':self.rev_id})
 
286
        finally:
 
287
            self.branch.unlock()
 
288
 
 
289
    def _record_inventory(self):
 
290
        """Store the inventory for the new revision."""
 
291
        inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
 
292
        self.inv_sha1 = sha_string(inv_text)
 
293
        s = self.branch.control_weaves
 
294
        s.add_text('inventory', self.rev_id,
 
295
                   split_lines(inv_text), self.present_parents,
 
296
                   self.branch.get_transaction())
 
297
 
 
298
    def _escape_commit_message(self):
 
299
        """Replace xml-incompatible control characters."""
 
300
        # Python strings can include characters that can't be
 
301
        # represented in well-formed XML; escape characters that
 
302
        # aren't listed in the XML specification
 
303
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
304
        self.message, escape_count = re.subn(
 
305
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
306
            lambda match: match.group(0).encode('unicode_escape'),
 
307
            self.message)
 
308
        if escape_count:
 
309
            self.reporter.escaped(escape_count, self.message)
 
310
 
 
311
    def _gather_parents(self):
 
312
        """Record the parents of a merge for merge detection."""
 
313
        pending_merges = self.work_tree.pending_merges()
 
314
        self.parents = []
 
315
        self.parent_invs = []
 
316
        self.present_parents = []
 
317
        precursor_id = self.branch.last_revision()
 
318
        if precursor_id:
 
319
            self.parents.append(precursor_id)
 
320
        self.parents += pending_merges
 
321
        for revision in self.parents:
 
322
            if self.branch.has_revision(revision):
 
323
                self.parent_invs.append(self.branch.get_inventory(revision))
 
324
                self.present_parents.append(revision)
 
325
 
 
326
    def _check_parents_present(self):
 
327
        for parent_id in self.parents:
 
328
            mutter('commit parent revision {%s}', parent_id)
 
329
            if not self.branch.has_revision(parent_id):
 
330
                if parent_id == self.branch.last_revision():
 
331
                    warning("parent is missing %r", parent_id)
 
332
                    raise HistoryMissing(self.branch, 'revision', parent_id)
405
333
                else:
406
 
                    master_location = self.branch.base
407
 
 
408
 
                # report the start of the commit
409
 
                self.reporter.started(new_revno, self.rev_id, master_location)
410
 
 
411
 
                self._update_builder_with_changes()
412
 
                self._check_pointless()
413
 
 
414
 
                # TODO: Now the new inventory is known, check for conflicts.
415
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
416
 
                # weave lines, because nothing should be recorded until it is known
417
 
                # that commit will succeed.
418
 
                self._set_progress_stage("Saving data locally")
419
 
                self.builder.finish_inventory()
420
 
 
421
 
                # Prompt the user for a commit message if none provided
422
 
                message = message_callback(self)
423
 
                self.message = message
424
 
 
425
 
                # Add revision data to the local branch
426
 
                self.rev_id = self.builder.commit(self.message)
427
 
 
428
 
            except Exception:
429
 
                mutter("aborting commit write group because of exception:")
430
 
                trace.log_exception_quietly()
431
 
                self.builder.abort()
432
 
                raise
433
 
 
434
 
            self._update_branches(old_revno, old_revid, new_revno)
435
 
 
436
 
            # Make the working tree be up to date with the branch. This
437
 
            # includes automatic changes scheduled to be made to the tree, such
438
 
            # as updating its basis and unversioning paths that were missing.
439
 
            self.work_tree.unversion(self.deleted_paths)
440
 
            self._set_progress_stage("Updating the working tree")
441
 
            self.work_tree.update_basis_by_delta(
442
 
                self.rev_id, self.builder.get_basis_delta())
443
 
            self.reporter.completed(new_revno, self.rev_id)
444
 
            self._process_post_hooks(old_revno, new_revno)
445
 
            return self.rev_id
446
 
 
447
 
    def _update_branches(self, old_revno, old_revid, new_revno):
448
 
        """Update the master and local branch to the new revision.
449
 
 
450
 
        This will try to make sure that the master branch is updated
451
 
        before the local branch.
452
 
 
453
 
        :param old_revno: Revision number of master branch before the
454
 
            commit
455
 
        :param old_revid: Tip of master branch before the commit
456
 
        :param new_revno: Revision number of the new commit
457
 
        """
458
 
        if not self.builder.updates_branch:
459
 
            self._process_pre_hooks(old_revno, new_revno)
460
 
 
461
 
            # Upload revision data to the master.
462
 
            # this will propagate merged revisions too if needed.
463
 
            if self.bound_branch:
464
 
                self._set_progress_stage("Uploading data to master branch")
465
 
                # 'commit' to the master first so a timeout here causes the
466
 
                # local branch to be out of date
467
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
468
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
469
 
                if self._lossy:
470
 
                    self.branch.fetch(self.master_branch, self.rev_id)
471
 
 
472
 
            # and now do the commit locally.
473
 
            if new_revno is None:
474
 
                # Keep existing behaviour around ghosts
475
 
                new_revno = 1
476
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
477
 
        else:
478
 
            try:
479
 
                self._process_pre_hooks(old_revno, new_revno)
480
 
            except BaseException:
481
 
                # The commit builder will already have updated the branch,
482
 
                # revert it.
483
 
                self.branch.set_last_revision_info(old_revno, old_revid)
484
 
                raise
485
 
 
486
 
        # Merge local tags to remote
487
 
        if self.bound_branch:
488
 
            self._set_progress_stage("Merging tags to master branch")
489
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
490
 
                self.master_branch.tags)
491
 
            if tag_conflicts:
492
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
493
 
                note(gettext("Conflicting tags in bound branch:\n{0}".format(
494
 
                    "\n".join(warning_lines))))
495
 
 
496
 
    def _select_reporter(self):
497
 
        """Select the CommitReporter to use."""
498
 
        if is_quiet():
499
 
            return NullCommitReporter()
500
 
        return ReportCommitToLog()
501
 
 
502
 
    def _check_pointless(self):
503
 
        if self.allow_pointless:
504
 
            return
505
 
        # A merge with no effect on files
506
 
        if len(self.parents) > 1:
507
 
            return
508
 
        if self.builder.any_changes():
509
 
            return
510
 
        raise PointlessCommit()
511
 
 
512
 
    def _check_bound_branch(self, stack, possible_master_transports=None):
513
 
        """Check to see if the local branch is bound.
514
 
 
515
 
        If it is bound, then most of the commit will actually be
516
 
        done using the remote branch as the target branch.
517
 
        Only at the end will the local branch be updated.
518
 
        """
519
 
        if self.local and not self.branch.get_bound_location():
520
 
            raise errors.LocalRequiresBoundBranch()
521
 
 
522
 
        if not self.local:
523
 
            self.master_branch = self.branch.get_master_branch(
524
 
                possible_master_transports)
525
 
 
526
 
        if not self.master_branch:
527
 
            # make this branch the reference branch for out of date checks.
528
 
            self.master_branch = self.branch
529
 
            return
530
 
 
531
 
        # If the master branch is bound, we must fail
532
 
        master_bound_location = self.master_branch.get_bound_location()
533
 
        if master_bound_location:
534
 
            raise errors.CommitToDoubleBoundBranch(
535
 
                self.branch, self.master_branch, master_bound_location)
536
 
 
537
 
        # TODO: jam 20051230 We could automatically push local
538
 
        #       commits to the remote branch if they would fit.
539
 
        #       But for now, just require remote to be identical
540
 
        #       to local.
541
 
 
542
 
        # Make sure the local branch is identical to the master
543
 
        master_revid = self.master_branch.last_revision()
544
 
        local_revid = self.branch.last_revision()
545
 
        if local_revid != master_revid:
546
 
            raise errors.BoundBranchOutOfDate(self.branch,
547
 
                                              self.master_branch)
548
 
 
549
 
        # Now things are ready to change the master branch
550
 
        # so grab the lock
551
 
        self.bound_branch = self.branch
552
 
        stack.enter_context(self.master_branch.lock_write())
553
 
 
554
 
    def _check_out_of_date_tree(self):
555
 
        """Check that the working tree is up to date.
556
 
 
557
 
        :return: old_revision_number, old_revision_id, new_revision_number
558
 
            tuple
559
 
        """
560
 
        try:
561
 
            first_tree_parent = self.work_tree.get_parent_ids()[0]
562
 
        except IndexError:
563
 
            # if there are no parents, treat our parent as 'None'
564
 
            # this is so that we still consider the master branch
565
 
            # - in a checkout scenario the tree may have no
566
 
            # parents but the branch may do.
567
 
            first_tree_parent = breezy.revision.NULL_REVISION
568
 
        if (self.master_branch._format.stores_revno() or
569
 
                self.config_stack.get('calculate_revnos')):
570
 
            try:
571
 
                old_revno, master_last = self.master_branch.last_revision_info()
572
 
            except errors.UnsupportedOperation:
573
 
                master_last = self.master_branch.last_revision()
574
 
                old_revno = self.branch.revision_id_to_revno(master_last)
575
 
        else:
576
 
            master_last = self.master_branch.last_revision()
577
 
            old_revno = None
578
 
        if master_last != first_tree_parent:
579
 
            if master_last != breezy.revision.NULL_REVISION:
580
 
                raise errors.OutOfDateTree(self.work_tree)
581
 
        if (old_revno is not None and
582
 
                self.branch.repository.has_revision(first_tree_parent)):
583
 
            new_revno = old_revno + 1
584
 
        else:
585
 
            # ghost parents never appear in revision history.
586
 
            new_revno = None
587
 
        return old_revno, master_last, new_revno
588
 
 
589
 
    def _process_pre_hooks(self, old_revno, new_revno):
590
 
        """Process any registered pre commit hooks."""
591
 
        self._set_progress_stage("Running pre_commit hooks")
592
 
        self._process_hooks("pre_commit", old_revno, new_revno)
593
 
 
594
 
    def _process_post_hooks(self, old_revno, new_revno):
595
 
        """Process any registered post commit hooks."""
596
 
        # Process the post commit hooks, if any
597
 
        self._set_progress_stage("Running post_commit hooks")
598
 
        # old style commit hooks - should be deprecated ? (obsoleted in
599
 
        # 0.15^H^H^H^H 2.5.0)
600
 
        post_commit = self.config_stack.get('post_commit')
601
 
        if post_commit is not None:
602
 
            hooks = post_commit.split(' ')
603
 
            # this would be nicer with twisted.python.reflect.namedAny
604
 
            for hook in hooks:
605
 
                result = eval(hook + '(branch, rev_id)',
606
 
                              {'branch': self.branch,
607
 
                               'breezy': breezy,
608
 
                               'rev_id': self.rev_id})
609
 
        # process new style post commit hooks
610
 
        self._process_hooks("post_commit", old_revno, new_revno)
611
 
 
612
 
    def _process_hooks(self, hook_name, old_revno, new_revno):
613
 
        if not Branch.hooks[hook_name]:
614
 
            return
615
 
 
616
 
        # new style commit hooks:
617
 
        if not self.bound_branch:
618
 
            hook_master = self.branch
619
 
            hook_local = None
620
 
        else:
621
 
            hook_master = self.master_branch
622
 
            hook_local = self.branch
623
 
        # With bound branches, when the master is behind the local branch,
624
 
        # the 'old_revno' and old_revid values here are incorrect.
625
 
        # XXX: FIXME ^. RBC 20060206
626
 
        if self.parents:
627
 
            old_revid = self.parents[0]
628
 
        else:
629
 
            old_revid = breezy.revision.NULL_REVISION
630
 
 
631
 
        if hook_name == "pre_commit":
632
 
            future_tree = self.builder.revision_tree()
633
 
            tree_delta = future_tree.changes_from(self.basis_tree,
634
 
                                                  include_root=True)
635
 
 
636
 
        for hook in Branch.hooks[hook_name]:
637
 
            # show the running hook in the progress bar. As hooks may
638
 
            # end up doing nothing (e.g. because they are not configured by
639
 
            # the user) this is still showing progress, not showing overall
640
 
            # actions - its up to each plugin to show a UI if it want's to
641
 
            # (such as 'Emailing diff to foo@example.com').
642
 
            self.pb_stage_name = "Running %s hooks [%s]" % \
643
 
                (hook_name, Branch.hooks.get_hook_name(hook))
644
 
            self._emit_progress()
645
 
            if 'hooks' in debug.debug_flags:
646
 
                mutter("Invoking commit hook: %r", hook)
647
 
            if hook_name == "post_commit":
648
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
649
 
                     self.rev_id)
650
 
            elif hook_name == "pre_commit":
651
 
                hook(hook_local, hook_master,
652
 
                     old_revno, old_revid, new_revno, self.rev_id,
653
 
                     tree_delta, future_tree)
654
 
 
655
 
    def _update_builder_with_changes(self):
656
 
        """Update the commit builder with the data about what has changed.
657
 
        """
658
 
        specific_files = self.specific_files
659
 
        mutter("Selecting files for commit with filter %r", specific_files)
660
 
 
661
 
        self._check_strict()
662
 
        iter_changes = self.work_tree.iter_changes(
663
 
            self.basis_tree, specific_files=specific_files)
664
 
        if self.exclude:
665
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
666
 
        iter_changes = self._filter_iter_changes(iter_changes)
667
 
        for path, fs_hash in self.builder.record_iter_changes(
668
 
                self.work_tree, self.basis_revid, iter_changes):
669
 
            self.work_tree._observed_sha1(path, fs_hash)
670
 
 
671
 
    def _filter_iter_changes(self, iter_changes):
672
 
        """Process iter_changes.
673
 
 
674
 
        This method reports on the changes in iter_changes to the user, and
675
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
676
 
        entries. 'missing' entries have their
677
 
 
678
 
        :param iter_changes: An iter_changes to process.
679
 
        :return: A generator of changes.
680
 
        """
681
 
        reporter = self.reporter
682
 
        report_changes = reporter.is_verbose()
683
 
        deleted_paths = []
684
 
        for change in iter_changes:
685
 
            if report_changes:
686
 
                old_path = change.path[0]
687
 
                new_path = change.path[1]
688
 
                versioned = change.versioned[1]
689
 
            kind = change.kind[1]
690
 
            versioned = change.versioned[1]
691
 
            if kind is None and versioned:
692
 
                # 'missing' path
693
 
                if report_changes:
694
 
                    reporter.missing(new_path)
695
 
                if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
696
 
                    trace.warning('Ignoring "%s" as symlinks are not '
697
 
                                  'supported on this filesystem.' % (change.path[0],))
 
334
                    mutter("commit will ghost revision %r", parent_id)
 
335
            
 
336
    def _make_revision(self):
 
337
        """Record a new revision object for this commit."""
 
338
        self.rev = Revision(timestamp=self.timestamp,
 
339
                            timezone=self.timezone,
 
340
                            committer=self.committer,
 
341
                            message=self.message,
 
342
                            inventory_sha1=self.inv_sha1,
 
343
                            revision_id=self.rev_id,
 
344
                            properties=self.revprops)
 
345
        self.rev.parent_ids = self.parents
 
346
        rev_tmp = StringIO()
 
347
        serializer_v5.write_revision(self.rev, rev_tmp)
 
348
        rev_tmp.seek(0)
 
349
        if self.config.signature_needed():
 
350
            plaintext = Testament(self.rev, self.new_inv).as_short_text()
 
351
            self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
 
352
                                                 plaintext, self.rev_id)
 
353
        self.branch.revision_store.add(rev_tmp, self.rev_id)
 
354
        mutter('new revision_id is {%s}', self.rev_id)
 
355
 
 
356
    def _remove_deleted(self):
 
357
        """Remove deleted files from the working inventories.
 
358
 
 
359
        This is done prior to taking the working inventory as the
 
360
        basis for the new committed inventory.
 
361
 
 
362
        This returns true if any files
 
363
        *that existed in the basis inventory* were deleted.
 
364
        Files that were added and deleted
 
365
        in the working copy don't matter.
 
366
        """
 
367
        specific = self.specific_files
 
368
        deleted_ids = []
 
369
        for path, ie in self.work_inv.iter_entries():
 
370
            if specific and not is_inside_any(specific, path):
 
371
                continue
 
372
            if not self.work_tree.has_filename(path):
 
373
                self.reporter.missing(path)
 
374
                deleted_ids.append((path, ie.file_id))
 
375
        if deleted_ids:
 
376
            deleted_ids.sort(reverse=True)
 
377
            for path, file_id in deleted_ids:
 
378
                del self.work_inv[file_id]
 
379
            self.work_tree._write_inventory(self.work_inv)
 
380
 
 
381
    def _store_snapshot(self):
 
382
        """Pass over inventory and record a snapshot.
 
383
 
 
384
        Entries get a new revision when they are modified in 
 
385
        any way, which includes a merge with a new set of
 
386
        parents that have the same entry. 
 
387
        """
 
388
        # XXX: Need to think more here about when the user has
 
389
        # made a specific decision on a particular value -- c.f.
 
390
        # mark-merge.  
 
391
        for path, ie in self.new_inv.iter_entries():
 
392
            previous_entries = ie.find_previous_heads(
 
393
                self.parent_invs, 
 
394
                self.weave_store.get_weave_prelude_or_empty(ie.file_id,
 
395
                    self.branch.get_transaction()))
 
396
            if ie.revision is None:
 
397
                change = ie.snapshot(self.rev_id, path, previous_entries,
 
398
                                     self.work_tree, self.weave_store,
 
399
                                     self.branch.get_transaction())
 
400
            else:
 
401
                change = "unchanged"
 
402
            self.reporter.snapshot_change(change, path)
 
403
 
 
404
    def _populate_new_inv(self):
 
405
        """Build revision inventory.
 
406
 
 
407
        This creates a new empty inventory. Depending on
 
408
        which files are selected for commit, and what is present in the
 
409
        current tree, the new inventory is populated. inventory entries 
 
410
        which are candidates for modification have their revision set to
 
411
        None; inventory entries that are carried over untouched have their
 
412
        revision set to their prior value.
 
413
        """
 
414
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
415
        self.new_inv = Inventory()
 
416
        for path, new_ie in self.work_inv.iter_entries():
 
417
            file_id = new_ie.file_id
 
418
            mutter('check %s {%s}', path, new_ie.file_id)
 
419
            if self.specific_files:
 
420
                if not is_inside_any(self.specific_files, path):
 
421
                    mutter('%s not selected for commit', path)
 
422
                    self._carry_entry(file_id)
698
423
                    continue
699
 
                deleted_paths.append(change.path[1])
700
 
                # Reset the new path (None) and new versioned flag (False)
701
 
                change = change.discard_new()
702
 
                new_path = change.path[1]
703
 
                versioned = False
704
 
            elif kind == 'tree-reference':
705
 
                if self.recursive == 'down':
706
 
                    self._commit_nested_tree(change.path[1])
707
 
            if change.versioned[0] or change.versioned[1]:
708
 
                yield change
709
 
                if report_changes:
710
 
                    if new_path is None:
711
 
                        reporter.deleted(old_path)
712
 
                    elif old_path is None:
713
 
                        reporter.snapshot_change(gettext('added'), new_path)
714
 
                    elif old_path != new_path:
715
 
                        reporter.renamed(gettext('renamed'),
716
 
                                         old_path, new_path)
717
 
                    else:
718
 
                        if (new_path
719
 
                                or self.work_tree.branch.repository._format.rich_root_data):
720
 
                            # Don't report on changes to '' in non rich root
721
 
                            # repositories.
722
 
                            reporter.snapshot_change(
723
 
                                gettext('modified'), new_path)
724
 
            self._next_progress_entry()
725
 
        # Unversion files that were found to be deleted
726
 
        self.deleted_paths = deleted_paths
727
 
 
728
 
    def _check_strict(self):
729
 
        # XXX: when we use iter_changes this would likely be faster if
730
 
        # iter_changes would check for us (even in the presence of
731
 
        # selected_files).
732
 
        if self.strict:
733
 
            # raise an exception as soon as we find a single unknown.
734
 
            for unknown in self.work_tree.unknowns():
735
 
                raise StrictCommitFailed()
736
 
 
737
 
    def _commit_nested_tree(self, path):
738
 
        "Commit a nested tree."
739
 
        sub_tree = self.work_tree.get_nested_tree(path)
740
 
        # FIXME: be more comprehensive here:
741
 
        # this works when both trees are in --trees repository,
742
 
        # but when both are bound to a different repository,
743
 
        # it fails; a better way of approaching this is to
744
 
        # finally implement the explicit-caches approach design
745
 
        # a while back - RBC 20070306.
746
 
        if sub_tree.branch.repository.has_same_location(
747
 
                self.work_tree.branch.repository):
748
 
            sub_tree.branch.repository = \
749
 
                self.work_tree.branch.repository
750
 
        try:
751
 
            return sub_tree.commit(message=None, revprops=self.revprops,
752
 
                                   recursive=self.recursive,
753
 
                                   message_callback=self.message_callback,
754
 
                                   timestamp=self.timestamp,
755
 
                                   timezone=self.timezone,
756
 
                                   committer=self.committer,
757
 
                                   allow_pointless=self.allow_pointless,
758
 
                                   strict=self.strict, verbose=self.verbose,
759
 
                                   local=self.local, reporter=self.reporter)
760
 
        except PointlessCommit:
761
 
            return self.work_tree.get_reference_revision(path)
762
 
 
763
 
    def _set_progress_stage(self, name, counter=False):
764
 
        """Set the progress stage and emit an update to the progress bar."""
765
 
        self.pb_stage_name = name
766
 
        self.pb_stage_count += 1
767
 
        if counter:
768
 
            self.pb_entries_count = 0
769
 
        else:
770
 
            self.pb_entries_count = None
771
 
        self._emit_progress()
772
 
 
773
 
    def _next_progress_entry(self):
774
 
        """Emit an update to the progress bar and increment the entry count."""
775
 
        self.pb_entries_count += 1
776
 
        self._emit_progress()
777
 
 
778
 
    def _emit_progress(self):
779
 
        if self.pb_entries_count is not None:
780
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
781
 
                                                       self.pb_entries_count)
782
 
        else:
783
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
784
 
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
424
                else:
 
425
                    # this is selected, ensure its parents are too.
 
426
                    parent_id = new_ie.parent_id
 
427
                    while parent_id != ROOT_ID:
 
428
                        if not self.new_inv.has_id(parent_id):
 
429
                            ie = self._select_entry(self.work_inv[parent_id])
 
430
                            mutter('%s selected for commit because of %s',
 
431
                                   self.new_inv.id2path(parent_id), path)
 
432
 
 
433
                        ie = self.new_inv[parent_id]
 
434
                        if ie.revision is not None:
 
435
                            ie.revision = None
 
436
                            mutter('%s selected for commit because of %s',
 
437
                                   self.new_inv.id2path(parent_id), path)
 
438
                        parent_id = ie.parent_id
 
439
            mutter('%s selected for commit', path)
 
440
            self._select_entry(new_ie)
 
441
 
 
442
    def _select_entry(self, new_ie):
 
443
        """Make new_ie be considered for committing."""
 
444
        ie = new_ie.copy()
 
445
        ie.revision = None
 
446
        self.new_inv.add(ie)
 
447
        return ie
 
448
 
 
449
    def _carry_entry(self, file_id):
 
450
        """Carry the file unchanged from the basis revision."""
 
451
        if self.basis_inv.has_id(file_id):
 
452
            self.new_inv.add(self.basis_inv[file_id].copy())
 
453
 
 
454
    def _report_deletes(self):
 
455
        for file_id in self.basis_inv:
 
456
            if file_id not in self.new_inv:
 
457
                self.reporter.deleted(self.basis_inv.id2path(file_id))
 
458
 
 
459
def _gen_revision_id(config, when):
 
460
    """Return new revision-id."""
 
461
    s = '%s-%s-' % (config.user_email(), compact_date(when))
 
462
    s += hexlify(rand_bytes(8))
 
463
    return s