← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branchbuilder.py

  • Committer: Jelmer Vernooij
  • Date: 2011-10-14 13:56:45 UTC
  • mfrom: (6215 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20111014135645-phc3q3y21k2ks0s2
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branchbuilder.py
17
17
"""Utility for create branches with particular contents."""
18
18
 
19
19
from bzrlib import (
20
 
    bzrdir,
 
20
    controldir,
21
21
    commit,
22
22
    errors,
23
23
    memorytree,
 
24
    revision,
24
25
    )
25
26
 
26
27
 
63
64
            If the path of the transport does not exist but its parent does
64
65
            it will be created.
65
66
        :param format: Either a BzrDirFormat, or the name of a format in the
66
 
            bzrdir format registry for the branch to be built.
 
67
            controldir format registry for the branch to be built.
67
68
        :param branch: An already constructed branch to use.  This param is
68
69
            mutually exclusive with the transport and format params.
69
70
        """
81
82
            if format is None:
82
83
                format = 'default'
83
84
            if isinstance(format, str):
84
 
                format = bzrdir.format_registry.make_bzrdir(format)
85
 
            self._branch = bzrdir.BzrDir.create_branch_convenience(
 
85
                format = controldir.format_registry.make_bzrdir(format)
 
86
            self._branch = controldir.ControlDir.create_branch_convenience(
86
87
                transport.base, format=format, force_new_tree=False)
87
88
        self._tree = None
88
89
 
103
104
        finally:
104
105
            tree.unlock()
105
106
 
106
 
    def _do_commit(self, tree, message=None, **kwargs):
 
107
    def _do_commit(self, tree, message=None, message_callback=None, **kwargs):
107
108
        reporter = commit.NullCommitReporter()
108
 
        if message is None:
 
109
        if message is None and message_callback is None:
109
110
            message = u'commit %d' % (self._branch.revno() + 1,)
110
 
        return tree.commit(message,
 
111
        return tree.commit(message, message_callback=message_callback,
111
112
            reporter=reporter,
112
113
            **kwargs)
113
114
 
162
163
 
163
164
    def build_snapshot(self, revision_id, parent_ids, actions,
164
165
        message=None, timestamp=None, allow_leftmost_as_ghost=False,
165
 
        committer=None, timezone=None):
 
166
        committer=None, timezone=None, message_callback=None):
166
167
        """Build a commit, shaped in a specific way.
167
168
 
 
169
        Most of the actions are self-explanatory.  'flush' is special action to
 
170
        break a series of actions into discrete steps so that complex changes
 
171
        (such as unversioning a file-id and re-adding it with a different kind)
 
172
        can be expressed in a way that will clearly work.
 
173
 
168
174
        :param revision_id: The handle for the new commit, can be None
169
175
        :param parent_ids: A list of parent_ids to use for the commit.
170
176
            It can be None, which indicates to use the last commit.
173
179
            ('modify', ('file-id', 'new-content'))
174
180
            ('unversion', 'file-id')
175
181
            ('rename', ('orig-path', 'new-path'))
 
182
            ('flush', None)
176
183
        :param message: An optional commit message, if not supplied, a default
177
184
            commit message will be written.
 
185
        :param message_callback: A message callback to use for the commit, as
 
186
            per mutabletree.commit.
178
187
        :param timestamp: If non-None, set the timestamp of the commit to this
179
188
            value.
180
189
        :param timezone: An optional timezone for timestamp.
184
193
        :return: The revision_id of the new commit
185
194
        """
186
195
        if parent_ids is not None:
187
 
            base_id = parent_ids[0]
 
196
            if len(parent_ids) == 0:
 
197
                base_id = revision.NULL_REVISION
 
198
            else:
 
199
                base_id = parent_ids[0]
188
200
            if base_id != self._branch.last_revision():
189
201
                self._move_branch_pointer(base_id,
190
202
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
202
214
            # inventory entry. And the only public function to create a
203
215
            # directory is MemoryTree.mkdir() which creates the directory, but
204
216
            # also always adds it. So we have to use a multi-pass setup.
205
 
            to_add_directories = []
206
 
            to_add_files = []
207
 
            to_add_file_ids = []
208
 
            to_add_kinds = []
209
 
            new_contents = {}
210
 
            to_unversion_ids = []
211
 
            to_rename = []
 
217
            pending = _PendingActions()
212
218
            for action, info in actions:
213
219
                if action == 'add':
214
220
                    path, file_id, kind, content = info
215
221
                    if kind == 'directory':
216
 
                        to_add_directories.append((path, file_id))
 
222
                        pending.to_add_directories.append((path, file_id))
217
223
                    else:
218
 
                        to_add_files.append(path)
219
 
                        to_add_file_ids.append(file_id)
220
 
                        to_add_kinds.append(kind)
 
224
                        pending.to_add_files.append(path)
 
225
                        pending.to_add_file_ids.append(file_id)
 
226
                        pending.to_add_kinds.append(kind)
221
227
                        if content is not None:
222
 
                            new_contents[file_id] = content
 
228
                            pending.new_contents[file_id] = content
223
229
                elif action == 'modify':
224
230
                    file_id, content = info
225
 
                    new_contents[file_id] = content
 
231
                    pending.new_contents[file_id] = content
226
232
                elif action == 'unversion':
227
 
                    to_unversion_ids.append(info)
 
233
                    pending.to_unversion_ids.add(info)
228
234
                elif action == 'rename':
229
235
                    from_relpath, to_relpath = info
230
 
                    to_rename.append((from_relpath, to_relpath))
 
236
                    pending.to_rename.append((from_relpath, to_relpath))
 
237
                elif action == 'flush':
 
238
                    self._flush_pending(tree, pending)
 
239
                    pending = _PendingActions()
231
240
                else:
232
241
                    raise ValueError('Unknown build action: "%s"' % (action,))
233
 
            if to_unversion_ids:
234
 
                tree.unversion(to_unversion_ids)
235
 
            for path, file_id in to_add_directories:
236
 
                if path == '':
237
 
                    # Special case, because the path already exists
238
 
                    tree.add([path], [file_id], ['directory'])
239
 
                else:
240
 
                    tree.mkdir(path, file_id)
241
 
            for from_relpath, to_relpath in to_rename:
242
 
                tree.rename_one(from_relpath, to_relpath)
243
 
            tree.add(to_add_files, to_add_file_ids, to_add_kinds)
244
 
            for file_id, content in new_contents.iteritems():
245
 
                tree.put_file_bytes_non_atomic(file_id, content)
 
242
            self._flush_pending(tree, pending)
246
243
            return self._do_commit(tree, message=message, rev_id=revision_id,
247
 
                timestamp=timestamp, timezone=timezone, committer=committer)
 
244
                timestamp=timestamp, timezone=timezone, committer=committer,
 
245
                message_callback=message_callback)
248
246
        finally:
249
247
            tree.unlock()
250
248
 
 
249
    def _flush_pending(self, tree, pending):
 
250
        """Flush the pending actions in 'pending', i.e. apply them to 'tree'."""
 
251
        for path, file_id in pending.to_add_directories:
 
252
            if path == '':
 
253
                old_id = tree.path2id(path)
 
254
                if old_id is not None and old_id in pending.to_unversion_ids:
 
255
                    # We're overwriting this path, no need to unversion
 
256
                    pending.to_unversion_ids.discard(old_id)
 
257
                # Special case, because the path already exists
 
258
                tree.add([path], [file_id], ['directory'])
 
259
            else:
 
260
                tree.mkdir(path, file_id)
 
261
        for from_relpath, to_relpath in pending.to_rename:
 
262
            tree.rename_one(from_relpath, to_relpath)
 
263
        if pending.to_unversion_ids:
 
264
            tree.unversion(pending.to_unversion_ids)
 
265
        tree.add(pending.to_add_files, pending.to_add_file_ids, pending.to_add_kinds)
 
266
        for file_id, content in pending.new_contents.iteritems():
 
267
            tree.put_file_bytes_non_atomic(file_id, content)
 
268
 
251
269
    def get_branch(self):
252
270
        """Return the branch created by the builder."""
253
271
        return self._branch
 
272
 
 
273
 
 
274
class _PendingActions(object):
 
275
    """Pending actions for build_snapshot to take.
 
276
 
 
277
    This is just a simple class to hold a bunch of the intermediate state of
 
278
    build_snapshot in single object.
 
279
    """
 
280
 
 
281
    def __init__(self):
 
282
        self.to_add_directories = []
 
283
        self.to_add_files = []
 
284
        self.to_add_file_ids = []
 
285
        self.to_add_kinds = []
 
286
        self.new_contents = {}
 
287
        self.to_unversion_ids = set()
 
288
        self.to_rename = []
 
289