/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
1
# Copyright (C) 2007 Canonical Ltd
2
 
# Copyright (C) 2010 Jelmer Vernooij
3
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
"""An adapter between a Git control dir and a Bazaar ControlDir."""
 
17
"""An adapter between a Git control dir and a Bazaar BzrDir."""
19
18
 
20
19
from bzrlib import (
 
20
    bzrdir,
21
21
    errors as bzr_errors,
22
22
    lockable_files,
23
23
    urlutils,
27
27
LockWarner = getattr(lockable_files, "_LockWarner", None)
28
28
 
29
29
from bzrlib.plugins.git import (
30
 
    BareLocalGitControlDirFormat,
31
 
    LocalGitControlDirFormat,
 
30
    LocalGitBzrDirFormat,
 
31
    get_rich_root_format,
32
32
    )
33
 
try:
34
 
    from bzrlib.controldir import (
35
 
        ControlDir,
36
 
        format_registry,
37
 
        )
38
 
except ImportError:
39
 
    # bzr < 2.3
40
 
    from bzrlib.bzrdir import (
41
 
        BzrDir,
42
 
        format_registry,
43
 
        )
44
 
    ControlDir = BzrDir
45
33
 
46
34
 
47
35
class GitLock(object):
81
69
            self._lock_warner = LockWarner(repr(self))
82
70
 
83
71
 
84
 
class GitDirConfig(object):
85
 
 
86
 
    def get_default_stack_on(self):
87
 
        return None
88
 
 
89
 
    def set_default_stack_on(self, value):
90
 
        raise bzr_errors.BzrError("Cannot set configuration")
91
 
 
92
 
 
93
 
class GitDir(ControlDir):
 
72
class GitDir(bzrdir.BzrDir):
94
73
    """An adapter to the '.git' dir used by git."""
95
74
 
96
75
    def is_supported(self):
97
76
        return True
98
77
 
99
 
    def can_convert_format(self):
100
 
        return False
101
 
 
102
 
    def break_lock(self):
103
 
        pass
104
 
 
105
78
    def cloning_metadir(self, stacked=False):
106
 
        return format_registry.make_bzrdir("default")
 
79
        return get_rich_root_format(stacked)
107
80
 
108
81
    def _branch_name_to_ref(self, name):
109
 
        raise NotImplementedError(self._branch_name_to_ref)
110
 
 
111
 
    if bzrlib_version >= (2, 2):
112
 
        def open_branch(self, name=None, unsupported=False, 
113
 
            ignore_fallbacks=None):
114
 
            return self._open_branch(name=name,
115
 
                ignore_fallbacks=ignore_fallbacks, unsupported=unsupported)
116
 
    else:
117
 
        def open_branch(self, ignore_fallbacks=None, unsupported=False):
118
 
            return self._open_branch(name=None,
119
 
                ignore_fallbacks=ignore_fallbacks, unsupported=unsupported)
120
 
 
121
 
    def get_config(self):
122
 
        return GitDirConfig()
 
82
        from bzrlib.plugins.git.branch import branch_name_to_ref
 
83
        return branch_name_to_ref(name)
123
84
 
124
85
 
125
86
class LocalGitDir(GitDir):
131
92
 
132
93
    _gitrepository_class = property(_get_gitrepository_class)
133
94
 
134
 
    @property
135
 
    def user_transport(self):
136
 
        return self.root_transport
137
 
 
138
 
    @property
139
 
    def control_transport(self):
140
 
        return self.transport
141
 
 
142
95
    def __init__(self, transport, lockfiles, gitrepo, format):
143
96
        self._format = format
144
97
        self.root_transport = transport
145
 
        self._mode_check_done = False
146
98
        self._git = gitrepo
147
99
        if gitrepo.bare:
148
100
            self.transport = transport
151
103
        self._lockfiles = lockfiles
152
104
        self._mode_check_done = None
153
105
 
154
 
    def _branch_name_to_ref(self, name):
155
 
        from bzrlib.plugins.git.refs import branch_name_to_ref
156
 
        ref = branch_name_to_ref(name, None)
157
 
        if ref == "HEAD":
158
 
            from dulwich.repo import SYMREF
159
 
            refcontents = self._git.refs.read_ref(ref)
160
 
            if refcontents.startswith(SYMREF):
161
 
                ref = refcontents[len(SYMREF):]
162
 
        return ref
163
 
 
164
106
    def is_control_filename(self, filename):
165
107
        return filename == '.git' or filename.startswith('.git/')
166
108
 
167
 
    def get_branch_transport(self, branch_format, name=None):
 
109
    def get_branch_transport(self, branch_format):
168
110
        if branch_format is None:
169
111
            return self.transport
170
 
        if isinstance(branch_format, LocalGitControlDirFormat):
 
112
        if isinstance(branch_format, LocalGitBzrDirFormat):
171
113
            return self.transport
172
114
        raise bzr_errors.IncompatibleFormat(branch_format, self._format)
173
115
 
174
 
    def get_repository_transport(self, format):
175
 
        if format is None:
176
 
            return self.transport
177
 
        if isinstance(format, LocalGitControlDirFormat):
178
 
            return self.transport
179
 
        raise bzr_errors.IncompatibleFormat(format, self._format)
180
 
 
181
 
    def get_workingtree_transport(self, format):
182
 
        if format is None:
183
 
            return self.transport
184
 
        if isinstance(format, LocalGitControlDirFormat):
185
 
            return self.transport
186
 
        raise bzr_errors.IncompatibleFormat(format, self._format)
 
116
    get_repository_transport = get_branch_transport
 
117
    get_workingtree_transport = get_branch_transport
187
118
 
188
119
    def _open_branch(self, name=None, ignore_fallbacks=None, unsupported=False):
189
120
        """'create' a branch for this dir."""
192
123
        return LocalGitBranch(self, repo, self._branch_name_to_ref(name),
193
124
            self._lockfiles)
194
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
 
195
133
    def destroy_branch(self, name=None):
196
 
        refname = self._branch_name_to_ref(name)
197
 
        if not refname in self._git.refs:
198
 
            raise bzr_errors.NotBranchError(self.root_transport.base,
199
 
                    bzrdir=self)
200
 
        del self._git.refs[refname]
201
 
 
202
 
    def destroy_repository(self):
203
 
        raise bzr_errors.UnsupportedOperation(self.destroy_repository, self)
204
 
 
205
 
    def destroy_workingtree(self):
206
 
        raise bzr_errors.UnsupportedOperation(self.destroy_workingtree, self)
207
 
 
208
 
    def needs_format_conversion(self, format=None):
209
 
        return not isinstance(self._format, format.__class__)
 
134
        del self._git.refs[self._branch_name_to_ref(name)]
210
135
 
211
136
    def list_branches(self):
212
137
        ret = []
213
138
        for name in self._git.get_refs():
214
 
            if name.startswith("refs/heads/"):
 
139
            if name.startswith("refs/heads/") or name == "HEAD":
215
140
                ret.append(self.open_branch(name=name))
216
141
        return ret
217
142
 
222
147
    def open_workingtree(self, recommend_upgrade=True):
223
148
        if not self._git.bare:
224
149
            from dulwich.errors import NoIndexPresent
225
 
            repo = self.open_repository()
226
150
            try:
227
 
                index = repo._git.open_index()
 
151
                from bzrlib.plugins.git.workingtree import GitWorkingTree
 
152
                return GitWorkingTree(self, self.open_repository(),
 
153
                                                      self.open_branch())
228
154
            except NoIndexPresent:
229
155
                pass
230
 
            else:
231
 
                from bzrlib.plugins.git.workingtree import GitWorkingTree
232
 
                try:
233
 
                    branch = self.open_branch()
234
 
                except bzr_errors.NotBranchError:
235
 
                    pass
236
 
                else:
237
 
                    return GitWorkingTree(self, repo, branch, index)
238
156
        loc = urlutils.unescape_for_display(self.root_transport.base, 'ascii')
239
157
        raise bzr_errors.NoWorkingTree(loc)
240
158
 
243
161
 
244
162
    def create_branch(self, name=None):
245
163
        refname = self._branch_name_to_ref(name)
246
 
        from dulwich.protocol import ZERO_SHA
247
 
        self._git.refs[refname or "HEAD"] = ZERO_SHA
 
164
        self._git.refs[refname] = "0" * 40
248
165
        return self.open_branch(name)
249
166
 
250
167
    def backup_bzrdir(self):
268
185
        finally:
269
186
            f.close()
270
187
        return self.open_workingtree()
271
 
 
272
 
    def find_repository(self):
273
 
        """Find the repository that should be used.
274
 
 
275
 
        This does not require a branch as we use it to find the repo for
276
 
        new branches as well as to hook existing branches up to their
277
 
        repository.
278
 
        """
279
 
        return self.open_repository()
280
 
 
281
 
    def _find_creation_modes(self):
282
 
        """Determine the appropriate modes for files and directories.
283
 
 
284
 
        They're always set to be consistent with the base directory,
285
 
        assuming that this transport allows setting modes.
286
 
        """
287
 
        # TODO: Do we need or want an option (maybe a config setting) to turn
288
 
        # this off or override it for particular locations? -- mbp 20080512
289
 
        if self._mode_check_done:
290
 
            return
291
 
        self._mode_check_done = True
292
 
        try:
293
 
            st = self.transport.stat('.')
294
 
        except TransportNotPossible:
295
 
            self._dir_mode = None
296
 
            self._file_mode = None
297
 
        else:
298
 
            # Check the directory mode, but also make sure the created
299
 
            # directories and files are read-write for this user. This is
300
 
            # mostly a workaround for filesystems which lie about being able to
301
 
            # write to a directory (cygwin & win32)
302
 
            if (st.st_mode & 07777 == 00000):
303
 
                # FTP allows stat but does not return dir/file modes
304
 
                self._dir_mode = None
305
 
                self._file_mode = None
306
 
            else:
307
 
                self._dir_mode = (st.st_mode & 07777) | 00700
308
 
                # Remove the sticky and execute bits for files
309
 
                self._file_mode = self._dir_mode & ~07111
310
 
 
311
 
    def _get_file_mode(self):
312
 
        """Return Unix mode for newly created files, or None.
313
 
        """
314
 
        if not self._mode_check_done:
315
 
            self._find_creation_modes()
316
 
        return self._file_mode
317
 
 
318
 
    def _get_dir_mode(self):
319
 
        """Return Unix mode for newly created directories, or None.
320
 
        """
321
 
        if not self._mode_check_done:
322
 
            self._find_creation_modes()
323
 
        return self._dir_mode
324
 
 
325