← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/fakevfat.py

  • Committer: Robey Pointer
  • Date: 2006-06-29 23:25:48 UTC
  • mto: This revision was merged to the branch mainline in revision 1839.
  • Revision ID: robey@lag.net-20060629232548-25aaee5fe809193c
fix typo

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transport/fakevfat.py
 
1
# Copyright (C) 2006 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
"""Fake transport with some restrictions of Windows VFAT filesystems.
 
18
 
 
19
VFAT on Windows has several restrictions that are not present on unix
 
20
filesystems, which are imposed by this transport. 
 
21
 
 
22
VFAT is strictly 8-bit using codepages to represent non-ascii characters. 
 
23
This implementation currently doesn't model the codepage but just insists
 
24
on only ascii characters being written.
 
25
 
 
26
Restrictions imposed by this transport:
 
27
 
 
28
 * filenames are squashed to lowercase
 
29
 * filenames containing non-ascii characters are not allowed
 
30
 * filenames containing the characters "@<>" are not allowed
 
31
   (there should be more?)
 
32
 
 
33
Some other restrictions are not implemented yet, but possibly could be:
 
34
 
 
35
 * open files can't be deleted or renamed
 
36
 * directories containing open files can't be renamed
 
37
 * special device names (NUL, LPT, ...) are not allowed
 
38
 
 
39
"""
 
40
 
 
41
import re
 
42
 
 
43
from bzrlib.errors import TransportNotPossible
 
44
from bzrlib.transport.decorator import TransportDecorator, DecoratorServer
 
45
 
 
46
 
 
47
# TODO: It might be nice if these hooks were available in a more general way
 
48
# on all paths passed in to the Transport, so that we didn't have to hook
 
49
# every single method.
 
50
 
 
51
# TODO: Perhaps don't inherit from TransportDecorator so that methods
 
52
# which are not implemented here fail by default?
 
53
    
 
54
 
 
55
class FakeVFATTransportDecorator(TransportDecorator):
 
56
    """A decorator that can convert any transport to be readonly.
 
57
 
 
58
    This is requested via the 'vfat+' prefix to get_transport().
 
59
 
 
60
    This is intended only for use in testing and doesn't implement every
 
61
    method very well yet.
 
62
 
 
63
    This transport is typically layered on a local or memory transport
 
64
    which actually stored the files.
 
65
    """
 
66
 
 
67
    @classmethod
 
68
    def _get_url_prefix(self):
 
69
        """Readonly transport decorators are invoked via 'vfat+'"""
 
70
        return 'vfat+'
 
71
 
 
72
    def _squash_name(self, name):
 
73
        """Return vfat-squashed filename.
 
74
 
 
75
        The name is returned as it will be stored on disk.  This raises an
 
76
        error if there are invalid characters in the name.
 
77
        """
 
78
        if re.search(r'[?*:;<>]', name):
 
79
            raise ValueError("illegal characters for VFAT filename: %r" % name)
 
80
        return name.lower()
 
81
 
 
82
    def get(self, relpath):
 
83
        return self._decorated.get(self._squash_name(relpath))
 
84
 
 
85
    def mkdir(self, relpath, mode=None):
 
86
        return self._decorated.mkdir(self._squash_name(relpath), 0755)
 
87
 
 
88
    def has(self, relpath):
 
89
        return self._decorated.has(self._squash_name(relpath))
 
90
 
 
91
    def readv(self, relpath, offsets):
 
92
        return self._decorated.readv(self._squash_name(relpath), offsets)
 
93
 
 
94
    def put(self, relpath, f, mode=None):
 
95
        return self._decorated.put(self._squash_name(relpath), f, mode)
 
96
 
 
97
 
 
98
class FakeVFATServer(DecoratorServer):
 
99
    """A server that suggests connections through FakeVFATTransportDecorator
 
100
 
 
101
    For use in testing.
 
102
    """
 
103
 
 
104
    def get_decorator_class(self):
 
105
        return FakeVFATTransportDecorator
 
106
 
 
107
 
 
108
def get_test_permutations():
 
109
    """Return the permutations to be used in testing."""
 
110
    return [(FakeVFATTransportDecorator, FakeVFATServer),
 
111
            ]