/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
 
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
"""An adapter between a Git control dir and a Bazaar BzrDir."""
 
18
 
 
19
from bzrlib import (
 
20
    bzrdir,
 
21
    errors as bzr_errors,
 
22
    lockable_files,
 
23
    urlutils,
 
24
    version_info as bzrlib_version,
 
25
    )
 
26
 
 
27
LockWarner = getattr(lockable_files, "_LockWarner", None)
 
28
 
 
29
from bzrlib.plugins.git import (
 
30
    LocalGitBzrDirFormat,
 
31
    get_rich_root_format,
 
32
    )
 
33
 
 
34
 
 
35
class GitLock(object):
 
36
    """A lock that thunks through to Git."""
 
37
 
 
38
    def lock_write(self, token=None):
 
39
        pass
 
40
 
 
41
    def lock_read(self):
 
42
        pass
 
43
 
 
44
    def unlock(self):
 
45
        pass
 
46
 
 
47
    def peek(self):
 
48
        pass
 
49
 
 
50
    def validate_token(self, token):
 
51
        pass
 
52
 
 
53
    def break_lock(self):
 
54
        pass
 
55
 
 
56
 
 
57
class GitLockableFiles(lockable_files.LockableFiles):
 
58
    """Git specific lockable files abstraction."""
 
59
 
 
60
    def __init__(self, transport, lock):
 
61
        self._lock = lock
 
62
        self._transaction = None
 
63
        self._lock_mode = None
 
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))
 
70
 
 
71
 
 
72
class GitDir(bzrdir.BzrDir):
 
73
    """An adapter to the '.git' dir used by git."""
 
74
 
 
75
    def is_supported(self):
 
76
        return True
 
77
 
 
78
    def cloning_metadir(self, stacked=False):
 
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)
 
84
 
 
85
 
 
86
class LocalGitDir(GitDir):
 
87
    """An adapter to the '.git' dir used by git."""
 
88
 
 
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)
 
94
 
 
95
    def __init__(self, transport, lockfiles, gitrepo, format):
 
96
        self._format = format
 
97
        self.root_transport = transport
 
98
        self._git = gitrepo
 
99
        if gitrepo.bare:
 
100
            self.transport = transport
 
101
        else:
 
102
            self.transport = transport.clone('.git')
 
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/')
 
108
 
 
109
    def get_branch_transport(self, branch_format):
 
110
        if branch_format is None:
 
111
            return self.transport
 
112
        if isinstance(branch_format, LocalGitBzrDirFormat):
 
113
            return self.transport
 
114
        raise bzr_errors.IncompatibleFormat(branch_format, self._format)
 
115
 
 
116
    get_repository_transport = get_branch_transport
 
117
    get_workingtree_transport = get_branch_transport
 
118
 
 
119
    def _open_branch(self, name=None, ignore_fallbacks=None, unsupported=False):
 
120
        """'create' a branch for this dir."""
 
121
        repo = self.open_repository()
 
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
 
142
 
 
143
    def open_repository(self, shared=False):
 
144
        """'open' a repository for this dir."""
 
145
        return self._gitrepository_class(self, self._lockfiles)
 
146
 
 
147
    def open_workingtree(self, recommend_upgrade=True):
 
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)
 
158
 
 
159
    def create_repository(self, shared=False):
 
160
        return self.open_repository()
 
161
 
 
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"))
 
172
        else:
 
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()