← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branchbuilder.py

  • Committer: John Arbash Meinel
  • Date: 2010-02-17 17:11:16 UTC
  • mfrom: (4797.2.17 2.1)
  • mto: (4797.2.18 2.1)
  • mto: This revision was merged to the branch mainline in revision 5055.
  • Revision ID: john@arbash-meinel.com-20100217171116-h7t9223ystbnx5h8
merge bzr.2.1 in preparation for NEWS entry.

Show diffs side-by-side

added added

removed removed

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