/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/branchbuilder.py

  • Committer: John Arbash Meinel
  • Date: 2008-07-23 02:35:09 UTC
  • mto: (3514.4.17 merge_lca_multi)
  • mto: This revision was merged to the branch mainline in revision 3748.
  • Revision ID: john@arbash-meinel.com-20080723023509-1t4wkw5wjif7h72i
Implement rename_one on MemoryTree, and expose that in the Branch Builder

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branchbuilder.py
 
1
# Copyright (C) 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
"""Utility for create branches with particular contents."""
 
18
 
 
19
from bzrlib import bzrdir, errors, memorytree
 
20
 
 
21
 
 
22
class BranchBuilder(object):
 
23
    """A BranchBuilder aids creating Branches with particular shapes.
 
24
    
 
25
    The expected way to use BranchBuilder is to construct a
 
26
    BranchBuilder on the transport you want your branch on, and then call
 
27
    appropriate build_ methods on it to get the shape of history you want.
 
28
 
 
29
    For instance:
 
30
      builder = BranchBuilder(self.get_transport().clone('relpath'))
 
31
      builder.build_commit()
 
32
      builder.build_commit()
 
33
      builder.build_commit()
 
34
      branch = builder.get_branch()
 
35
    """
 
36
 
 
37
    def __init__(self, transport, format=None):
 
38
        """Construct a BranchBuilder on transport.
 
39
        
 
40
        :param transport: The transport the branch should be created on.
 
41
            If the path of the transport does not exist but its parent does
 
42
            it will be created.
 
43
        :param format: The name of a format in the bzrdir format registry
 
44
            for the branch to be built.
 
45
        """
 
46
        if not transport.has('.'):
 
47
            transport.mkdir('.')
 
48
        if format is None:
 
49
            format = 'default'
 
50
        if isinstance(format, str):
 
51
            format = bzrdir.format_registry.make_bzrdir(format)
 
52
        self._branch = bzrdir.BzrDir.create_branch_convenience(transport.base,
 
53
            format=format, force_new_tree=False)
 
54
        self._tree = None
 
55
 
 
56
    def build_commit(self):
 
57
        """Build a commit on the branch."""
 
58
        tree = memorytree.MemoryTree.create_on_branch(self._branch)
 
59
        tree.lock_write()
 
60
        try:
 
61
            tree.add('')
 
62
            return tree.commit('commit %d' % (self._branch.revno() + 1))
 
63
        finally:
 
64
            tree.unlock()
 
65
 
 
66
    def _move_branch_pointer(self, new_revision_id):
 
67
        """Point self._branch to a different revision id."""
 
68
        self._branch.lock_write()
 
69
        try:
 
70
            # We don't seem to have a simple set_last_revision(), so we
 
71
            # implement it here.
 
72
            cur_revno, cur_revision_id = self._branch.last_revision_info()
 
73
            g = self._branch.repository.get_graph()
 
74
            new_revno = g.find_distance_to_null(new_revision_id,
 
75
                                                [(cur_revision_id, cur_revno)])
 
76
            self._branch.set_last_revision_info(new_revno, new_revision_id)
 
77
        finally:
 
78
            self._branch.unlock()
 
79
        if self._tree is not None:
 
80
            # We are currently processing a series, but when switching branch
 
81
            # pointers, it is easiest to just create a new memory tree.
 
82
            # That way we are sure to have the right files-on-disk
 
83
            # We are cheating a little bit here, and locking the new tree
 
84
            # before the old tree is unlocked. But that way the branch stays
 
85
            # locked throughout.
 
86
            new_tree = memorytree.MemoryTree.create_on_branch(self._branch)
 
87
            new_tree.lock_write()
 
88
            self._tree.unlock()
 
89
            self._tree = new_tree
 
90
 
 
91
    def start_series(self):
 
92
        """We will be creating a series of commits.
 
93
 
 
94
        This allows us to hold open the locks while we are processing.
 
95
 
 
96
        Make sure to call 'finish_series' when you are done.
 
97
        """
 
98
        self._tree = memorytree.MemoryTree.create_on_branch(self._branch)
 
99
        self._tree.lock_write()
 
100
 
 
101
    def finish_series(self):
 
102
        """Call this after start_series to unlock the various objects."""
 
103
        self._tree.unlock()
 
104
        self._tree = None
 
105
 
 
106
    def build_snapshot(self, revision_id, parent_ids, actions,
 
107
                       message=None):
 
108
        """Build a commit, shaped in a specific way.
 
109
 
 
110
        :param revision_id: The handle for the new commit, can be None
 
111
        :param parent_ids: A list of parent_ids to use for the commit.
 
112
            It can be None, which indicates to use the last commit.
 
113
        :param actions: A list of actions to perform. Supported actions are:
 
114
            ('add', ('path', 'file-id', 'kind', 'content' or None))
 
115
            ('modify', ('file-id', 'new-content'))
 
116
            ('unversion', 'file-id')
 
117
            # not supported yet: ('rename', ('orig-path', 'new-path'))
 
118
        :param message: An optional commit message, if not supplied, a default
 
119
            commit message will be written.
 
120
        ;return: The revision_id of the new commit
 
121
        """
 
122
        if parent_ids is not None:
 
123
            base_id = parent_ids[0]
 
124
            if base_id != self._branch.last_revision():
 
125
                self._move_branch_pointer(base_id)
 
126
 
 
127
        if self._tree is not None:
 
128
            tree = self._tree
 
129
        else:
 
130
            tree = memorytree.MemoryTree.create_on_branch(self._branch)
 
131
        tree.lock_write()
 
132
        try:
 
133
            if parent_ids is not None:
 
134
                tree.set_parent_ids(parent_ids)
 
135
            # Unfortunately, MemoryTree.add(directory) just creates an
 
136
            # inventory entry. And the only public function to create a
 
137
            # directory is MemoryTree.mkdir() which creates the directory, but
 
138
            # also always adds it. So we have to use a multi-pass setup.
 
139
            to_add_directories = []
 
140
            to_add_files = []
 
141
            to_add_file_ids = []
 
142
            to_add_kinds = []
 
143
            new_contents = {}
 
144
            to_unversion_ids = []
 
145
            to_rename = []
 
146
            for action, info in actions:
 
147
                if action == 'add':
 
148
                    path, file_id, kind, content = info
 
149
                    if kind == 'directory':
 
150
                        to_add_directories.append((path, file_id))
 
151
                    else:
 
152
                        to_add_files.append(path)
 
153
                        to_add_file_ids.append(file_id)
 
154
                        to_add_kinds.append(kind)
 
155
                        if content is not None:
 
156
                            new_contents[file_id] = content
 
157
                elif action == 'modify':
 
158
                    file_id, content = info
 
159
                    new_contents[file_id] = content
 
160
                elif action == 'unversion':
 
161
                    to_unversion_ids.append(info)
 
162
                elif action == 'rename':
 
163
                    from_relpath, to_relpath = info
 
164
                    to_rename.append((from_relpath, to_relpath))
 
165
                else:
 
166
                    raise errors.UnknownBuildAction(action)
 
167
            if to_unversion_ids:
 
168
                tree.unversion(to_unversion_ids)
 
169
            for path, file_id in to_add_directories:
 
170
                if path == '':
 
171
                    # Special case, because the path already exists
 
172
                    tree.add([path], [file_id], ['directory'])
 
173
                else:
 
174
                    tree.mkdir(path, file_id)
 
175
            for from_relpath, to_relpath in to_rename:
 
176
                tree.rename_one(from_relpath, to_relpath)
 
177
            tree.add(to_add_files, to_add_file_ids, to_add_kinds)
 
178
            for file_id, content in new_contents.iteritems():
 
179
                tree.put_file_bytes_non_atomic(file_id, content)
 
180
 
 
181
            if message is None:
 
182
                message = u'commit %d' % (self._branch.revno() + 1,)
 
183
            return tree.commit(message, rev_id=revision_id)
 
184
        finally:
 
185
            tree.unlock()
 
186
 
 
187
    def get_branch(self):
 
188
        """Return the branch created by the builder."""
 
189
        return self._branch