← 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-10 17:52:08 UTC
  • mfrom: (5021 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5023.
  • Revision ID: john@arbash-meinel.com-20100210175208-bubuwav4uqigu291
Merge bzr.dev 5021 to resolve NEWS

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