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

Add docstring.

Show diffs side-by-side

added added

removed removed

Lines of Context:
dir.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""An adapter between a Git control dir and a Bazaar BzrDir"""
18
 
 
19
 
import os
20
 
 
21
 
import bzrlib
22
 
from bzrlib.lazy_import import lazy_import
 
17
"""An adapter between a Git control dir and a Bazaar BzrDir."""
 
18
 
23
19
from bzrlib import (
24
20
    bzrdir,
 
21
    errors as bzr_errors,
25
22
    lockable_files,
26
23
    urlutils,
 
24
    version_info as bzrlib_version,
27
25
    )
28
26
 
29
 
lazy_import(globals(), """
30
 
from bzrlib.lockable_files import TransportLock
 
27
LockWarner = getattr(lockable_files, "_LockWarner", None)
 
28
 
31
29
from bzrlib.plugins.git import (
32
 
    errors,
33
 
    branch,
34
 
    repository,
35
 
    workingtree,
 
30
    LocalGitBzrDirFormat,
 
31
    get_rich_root_format,
36
32
    )
37
 
""")
38
 
 
39
33
 
40
34
 
41
35
class GitLock(object):
56
50
    def validate_token(self, token):
57
51
        pass
58
52
 
 
53
    def break_lock(self):
 
54
        pass
 
55
 
59
56
 
60
57
class GitLockableFiles(lockable_files.LockableFiles):
61
58
    """Git specific lockable files abstraction."""
64
61
        self._lock = lock
65
62
        self._transaction = None
66
63
        self._lock_mode = None
67
 
        self._lock_count = 0
68
64
        self._transport = transport
 
65
        if LockWarner is None:
 
66
            # Bzr 1.13
 
67
            self._lock_count = 0
 
68
        else:
 
69
            self._lock_warner = LockWarner(repr(self))
69
70
 
70
71
 
71
72
class GitDir(bzrdir.BzrDir):
75
76
        return True
76
77
 
77
78
    def cloning_metadir(self, stacked=False):
78
 
        if stacked:
79
 
            return bzrlib.bzrdir.format_registry.make_bzrdir("pack-0.92")
80
 
        else:
81
 
            return bzrlib.bzrdir.format_registry.make_bzrdir("1.6")
 
79
        return get_rich_root_format(stacked)
 
80
 
 
81
    def _branch_name_to_ref(self, name):
 
82
        from bzrlib.plugins.git.branch import branch_name_to_ref
 
83
        return branch_name_to_ref(name)
82
84
 
83
85
 
84
86
class LocalGitDir(GitDir):
85
87
    """An adapter to the '.git' dir used by git."""
86
88
 
87
 
    _gitrepository_class = repository.LocalGitRepository
 
89
    def _get_gitrepository_class(self):
 
90
        from bzrlib.plugins.git.repository import LocalGitRepository
 
91
        return LocalGitRepository
 
92
 
 
93
    _gitrepository_class = property(_get_gitrepository_class)
88
94
 
89
95
    def __init__(self, transport, lockfiles, gitrepo, format):
90
96
        self._format = format
95
101
        else:
96
102
            self.transport = transport.clone('.git')
97
103
        self._lockfiles = lockfiles
 
104
        self._mode_check_done = None
 
105
 
 
106
    def is_control_filename(self, filename):
 
107
        return filename == '.git' or filename.startswith('.git/')
98
108
 
99
109
    def get_branch_transport(self, branch_format):
100
110
        if branch_format is None:
101
111
            return self.transport
102
112
        if isinstance(branch_format, LocalGitBzrDirFormat):
103
113
            return self.transport
104
 
        raise errors.bzr_errors.IncompatibleFormat(branch_format, self._format)
 
114
        raise bzr_errors.IncompatibleFormat(branch_format, self._format)
105
115
 
106
116
    get_repository_transport = get_branch_transport
107
117
    get_workingtree_transport = get_branch_transport
108
118
 
109
 
    def open_branch(self, ignored=None):
 
119
    def _open_branch(self, name=None, ignore_fallbacks=None, unsupported=False):
110
120
        """'create' a branch for this dir."""
111
121
        repo = self.open_repository()
112
 
        return branch.LocalGitBranch(self, repo, "HEAD", repo._git.head(), self._lockfiles)
 
122
        from bzrlib.plugins.git.branch import LocalGitBranch
 
123
        return LocalGitBranch(self, repo, self._branch_name_to_ref(name),
 
124
            self._lockfiles)
 
125
 
 
126
    if bzrlib_version >= (2, 2):
 
127
        open_branch = _open_branch
 
128
    else:
 
129
        def open_branch(self, ignore_fallbacks=None, unsupported=False):
 
130
            return self._open_branch(name=None,
 
131
                ignore_fallbacks=ignore_fallbacks, unsupported=unsupported)
 
132
 
 
133
    def destroy_branch(self, name=None):
 
134
        del self._git.refs[self._branch_name_to_ref(name)]
 
135
 
 
136
    def list_branches(self):
 
137
        ret = []
 
138
        for name in self._git.get_refs():
 
139
            if name.startswith("refs/heads/") or name == "HEAD":
 
140
                ret.append(self.open_branch(name=name))
 
141
        return ret
113
142
 
114
143
    def open_repository(self, shared=False):
115
144
        """'open' a repository for this dir."""
116
145
        return self._gitrepository_class(self, self._lockfiles)
117
146
 
118
147
    def open_workingtree(self, recommend_upgrade=True):
119
 
        if self._git.bare:
120
 
            loc = urlutils.unescape_for_display(self.root_transport.base, 'ascii')
121
 
            raise errors.bzr_errors.NoWorkingTree(loc)
122
 
        else:
123
 
            return workingtree.GitWorkingTree(self, self.open_repository(), 
124
 
                                                  self.open_branch())
 
148
        if not self._git.bare:
 
149
            from dulwich.errors import NoIndexPresent
 
150
            try:
 
151
                from bzrlib.plugins.git.workingtree import GitWorkingTree
 
152
                return GitWorkingTree(self, self.open_repository(),
 
153
                                                      self.open_branch())
 
154
            except NoIndexPresent:
 
155
                pass
 
156
        loc = urlutils.unescape_for_display(self.root_transport.base, 'ascii')
 
157
        raise bzr_errors.NoWorkingTree(loc)
125
158
 
126
159
    def create_repository(self, shared=False):
127
160
        return self.open_repository()
128
161
 
129
 
 
130
 
class GitBzrDirFormat(bzrdir.BzrDirFormat):
131
 
    _lock_class = TransportLock
132
 
 
133
 
    def is_supported(self):
134
 
        return True
135
 
 
136
 
 
137
 
class LocalGitBzrDirFormat(GitBzrDirFormat):
138
 
    """The .git directory control format."""
139
 
 
140
 
    _gitdir_class = LocalGitDir
141
 
 
142
 
    @classmethod
143
 
    def _known_formats(self):
144
 
        return set([LocalGitBzrDirFormat()])
145
 
 
146
 
    def open(self, transport, _found=None):
147
 
        """Open this directory.
148
 
 
149
 
        """
150
 
        from bzrlib.plugins.git import git
151
 
        # we dont grok readonly - git isn't integrated with transport.
152
 
        url = transport.base
153
 
        if url.startswith('readonly+'):
154
 
            url = url[len('readonly+'):]
155
 
 
156
 
        try:
157
 
            gitrepo = git.repo.Repo(transport.local_abspath("."))
158
 
        except errors.bzr_errors.NotLocalUrl:
159
 
            raise errors.bzr_errors.NotBranchError(path=transport.base)
160
 
        lockfiles = GitLockableFiles(transport, GitLock())
161
 
        return self._gitdir_class(transport, lockfiles, gitrepo, self)
162
 
 
163
 
    @classmethod
164
 
    def probe_transport(klass, transport):
165
 
        """Our format is present if the transport ends in '.not/'."""
166
 
        from bzrlib.plugins.git import git
167
 
        # little ugly, but works
168
 
        format = klass()
169
 
        # delegate to the main opening code. This pays a double rtt cost at the
170
 
        # moment, so perhaps we want probe_transport to return the opened thing
171
 
        # rather than an openener ? or we could return a curried thing with the
172
 
        # dir to open already instantiated ? Needs more thought.
173
 
        try:
174
 
            format.open(transport)
175
 
            return format
176
 
        except git.errors.NotGitRepository, e:
177
 
            raise errors.bzr_errors.NotBranchError(path=transport.base)
178
 
        raise errors.bzr_errors.NotBranchError(path=transport.base)
179
 
 
180
 
    def get_format_description(self):
181
 
        return "Local Git Repository"
182
 
 
183
 
    def get_format_string(self):
184
 
        return "Local Git Repository"
185
 
 
186
 
    def initialize_on_transport(self, transport):
187
 
        from bzrlib.transport.local import LocalTransport
188
 
        from bzrlib.plugins.git import git
189
 
 
190
 
        if not isinstance(transport, LocalTransport):
191
 
            raise NotImplementedError(self.initialize, 
192
 
                "Can't create Git Repositories/branches on "
193
 
                "non-local transports")
194
 
 
195
 
        git.repo.Repo.create(transport.local_abspath(".")) 
196
 
        return self.open(transport)
197
 
 
198
 
    def is_supported(self):
199
 
        return True
200
 
 
201
 
 
202
 
class RemoteGitBzrDirFormat(GitBzrDirFormat):
203
 
    """The .git directory control format."""
204
 
 
205
 
    @classmethod
206
 
    def _known_formats(self):
207
 
        return set([RemoteGitBzrDirFormat()])
208
 
 
209
 
    def open(self, transport, _found=None):
210
 
        """Open this directory.
211
 
 
212
 
        """
213
 
        from bzrlib.plugins.git.remote import RemoteGitDir, GitSmartTransport
214
 
        if not isinstance(transport, GitSmartTransport):
215
 
            raise errors.bzr_errors.NotBranchError(transport.base)
216
 
        # we dont grok readonly - git isn't integrated with transport.
217
 
        url = transport.base
218
 
        if url.startswith('readonly+'):
219
 
            url = url[len('readonly+'):]
220
 
 
221
 
        lockfiles = GitLockableFiles(transport, GitLock())
222
 
        return RemoteGitDir(transport, lockfiles, self)
223
 
 
224
 
    @classmethod
225
 
    def probe_transport(klass, transport):
226
 
        """Our format is present if the transport ends in '.not/'."""
227
 
        # little ugly, but works
228
 
        format = klass()
229
 
        from bzrlib.plugins.git.remote import GitSmartTransport
230
 
        if not isinstance(transport, GitSmartTransport):
231
 
            raise errors.bzr_errors.NotBranchError(transport.base)
232
 
        # The only way to know a path exists and contains a valid repository 
233
 
        # is to do a request against it:
234
 
        try:
235
 
            transport.fetch_pack(lambda x: [], None, lambda x: None, 
236
 
                                 lambda x: mutter("git: %s" % x))
237
 
        except GitProtocolException, e:
238
 
            raise errors.bzr_errors.NotBranchError(path=transport.base)
 
162
    def create_branch(self, name=None):
 
163
        refname = self._branch_name_to_ref(name)
 
164
        self._git.refs[refname] = "0" * 40
 
165
        return self.open_branch(name)
 
166
 
 
167
    def backup_bzrdir(self):
 
168
        if self._git.bare:
 
169
            self.root_transport.copy_tree(".git", ".git.backup")
 
170
            return (self.root_transport.abspath(".git"),
 
171
                    self.root_transport.abspath(".git.backup"))
239
172
        else:
240
 
            return format
241
 
        raise errors.bzr_errors.NotBranchError(path=transport.base)
242
 
 
243
 
    def get_format_description(self):
244
 
        return "Remote Git Repository"
245
 
 
246
 
    def get_format_string(self):
247
 
        return "Remote Git Repository"
248
 
 
249
 
    def initialize_on_transport(self, transport):
250
 
        raise errors.bzr_errors.UninitializableFormat(self)
251
 
 
 
173
            raise bzr_errors.BzrError("Unable to backup bare repositories")
 
174
 
 
175
    def create_workingtree(self, revision_id=None, from_branch=None,
 
176
        accelerator_tree=None, hardlink=False):
 
177
        if self._git.bare:
 
178
            raise bzr_errors.BzrError("Can't create working tree in a bare repo")
 
179
        from dulwich.index import write_index
 
180
        from dulwich.pack import SHA1Writer
 
181
        f = open(self.transport.local_abspath("index"), 'w+')
 
182
        try:
 
183
            f = SHA1Writer(f)
 
184
            write_index(f, [])
 
185
        finally:
 
186
            f.close()
 
187
        return self.open_workingtree()