2011-01-18 Dirk Pranke <dpranke@chromium.org>
[WebKit.git] / Tools / Scripts / webkitpy / common / system / filesystem.py
1 # Copyright (C) 2010 Google Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6 #
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the name of Google Inc. nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 """Wrapper object for the file system / source tree."""
30
31 from __future__ import with_statement
32
33 import codecs
34 import errno
35 import exceptions
36 import os
37 import shutil
38 import tempfile
39 import time
40
41 class FileSystem(object):
42     """FileSystem interface for webkitpy.
43
44     Unless otherwise noted, all paths are allowed to be either absolute
45     or relative."""
46
47     def basename(self, path):
48         return os.path.basename(path)
49
50     def copyfile(self, source, destination):
51         """Copies the contents of the file at the given path to the destination
52         path."""
53         shutil.copyfile(source, destination)
54
55     def dirname(self, path):
56         return os.path.dirname(path)
57
58     def exists(self, path):
59         """Return whether the path exists in the filesystem."""
60         return os.path.exists(path)
61
62     def files_under(self, path):
63         """Return the list of all files under the given path."""
64         return [self.join(path_to_file, filename)
65             for (path_to_file, _, filenames) in os.walk(path)
66             for filename in filenames]
67
68     def isfile(self, path):
69         """Return whether the path refers to a file."""
70         return os.path.isfile(path)
71
72     def isdir(self, path):
73         """Return whether the path refers to a directory."""
74         return os.path.isdir(path)
75
76     def join(self, *comps):
77         """Return the path formed by joining the components."""
78         return os.path.join(*comps)
79
80     def listdir(self, path):
81         """Return the contents of the directory pointed to by path."""
82         return os.listdir(path)
83
84     def mkdtemp(self, **kwargs):
85         """Create and return a uniquely named directory.
86
87         This is like tempfile.mkdtemp, but if used in a with statement
88         the directory will self-delete at the end of the block (if the
89         directory is empty; non-empty directories raise errors). The
90         directory can be safely deleted inside the block as well, if so
91         desired.
92
93         Note that the object returned is not a string and does not support all of the string
94         methods. If you need a string, coerce the object to a string and go from there.
95         """
96         class TemporaryDirectory(object):
97             def __init__(self, **kwargs):
98                 self._kwargs = kwargs
99                 self._directory_path = tempfile.mkdtemp(**self._kwargs)
100
101             def __str__(self):
102                 return self._directory_path
103
104             def __enter__(self):
105                 return self._directory_path
106
107             def __exit__(self, type, value, traceback):
108                 # Only self-delete if necessary.
109
110                 # FIXME: Should we delete non-empty directories?
111                 if os.path.exists(self._directory_path):
112                     os.rmdir(self._directory_path)
113
114         return TemporaryDirectory(**kwargs)
115
116     def maybe_make_directory(self, *path):
117         """Create the specified directory if it doesn't already exist."""
118         try:
119             os.makedirs(self.join(*path))
120         except OSError, e:
121             if e.errno != errno.EEXIST:
122                 raise
123
124     def move(self, src, dest):
125         shutil.move(src, dest)
126
127     def normpath(self, path):
128         return os.path.normpath(path)
129
130     def open_binary_tempfile(self, suffix):
131         """Create, open, and return a binary temp file. Returns a tuple of the file and the name."""
132         temp_fd, temp_name = tempfile.mkstemp(suffix)
133         f = os.fdopen(temp_fd, 'wb')
134         return f, temp_name
135
136     def read_binary_file(self, path):
137         """Return the contents of the file at the given path as a byte string."""
138         with file(path, 'rb') as f:
139             return f.read()
140
141     def read_text_file(self, path):
142         """Return the contents of the file at the given path as a Unicode string.
143
144         The file is read assuming it is a UTF-8 encoded file with no BOM."""
145         with codecs.open(path, 'r', 'utf8') as f:
146             return f.read()
147
148     class _WindowsError(exceptions.OSError):
149         """Fake exception for Linux and Mac."""
150         pass
151
152     def remove(self, path, osremove=os.remove):
153         """On Windows, if a process was recently killed and it held on to a
154         file, the OS will hold on to the file for a short while.  This makes
155         attempts to delete the file fail.  To work around that, this method
156         will retry for a few seconds until Windows is done with the file."""
157         try:
158             exceptions.WindowsError
159         except AttributeError:
160             exceptions.WindowsError = FileSystem._WindowsError
161
162         retry_timeout_sec = 3.0
163         sleep_interval = 0.1
164         while True:
165             try:
166                 osremove(path)
167                 return True
168             except exceptions.WindowsError, e:
169                 time.sleep(sleep_interval)
170                 retry_timeout_sec -= sleep_interval
171                 if retry_timeout_sec < 0:
172                     raise e
173
174     def rmtree(self, path):
175         """Delete the directory rooted at path, empty or no."""
176         shutil.rmtree(path, ignore_errors=True)
177
178     def read_binary_file(self, path):
179         """Return the contents of the file at the given path as a byte string."""
180         with file(path, 'rb') as f:
181             return f.read()
182
183     def read_text_file(self, path):
184         """Return the contents of the file at the given path as a Unicode string.
185
186         The file is read assuming it is a UTF-8 encoded file with no BOM."""
187         with codecs.open(path, 'r', 'utf8') as f:
188             return f.read()
189
190     def splitext(self, path):
191         """Return (dirname, basename + ext)."""
192         return os.path.splitext(path)
193
194     def write_binary_file(self, path, contents):
195         """Write the contents to the file at the given location."""
196         with file(path, 'wb') as f:
197             f.write(contents)
198
199     def write_text_file(self, path, contents):
200         """Write the contents to the file at the given location.
201
202         The file is written encoded as UTF-8 with no BOM."""
203         with codecs.open(path, 'w', 'utf8') as f:
204             f.write(contents)