d45d4c1b1f696f42e1e3ee348f4e221facf8d384
[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 glob
37 import os
38 import shutil
39 import tempfile
40 import time
41
42 class FileSystem(object):
43     """FileSystem interface for webkitpy.
44
45     Unless otherwise noted, all paths are allowed to be either absolute
46     or relative."""
47
48     def basename(self, path):
49         """Wraps os.path.basename()."""
50         return os.path.basename(path)
51
52     def copyfile(self, source, destination):
53         """Copies the contents of the file at the given path to the destination
54         path."""
55         shutil.copyfile(source, destination)
56
57     def dirname(self, path):
58         """Wraps os.path.dirname()."""
59         return os.path.dirname(path)
60
61     def exists(self, path):
62         """Return whether the path exists in the filesystem."""
63         return os.path.exists(path)
64
65     def files_under(self, path):
66         """Return the list of all files under the given path."""
67         return [self.join(path_to_file, filename)
68             for (path_to_file, _, filenames) in os.walk(path)
69             for filename in filenames]
70
71     def glob(self, path):
72         """Wraps glob.glob()."""
73         return glob.glob(path)
74
75     def isfile(self, path):
76         """Return whether the path refers to a file."""
77         return os.path.isfile(path)
78
79     def isdir(self, path):
80         """Return whether the path refers to a directory."""
81         return os.path.isdir(path)
82
83     def join(self, *comps):
84         """Return the path formed by joining the components."""
85         return os.path.join(*comps)
86
87     def listdir(self, path):
88         """Return the contents of the directory pointed to by path."""
89         return os.listdir(path)
90
91     def mkdtemp(self, **kwargs):
92         """Create and return a uniquely named directory.
93
94         This is like tempfile.mkdtemp, but if used in a with statement
95         the directory will self-delete at the end of the block (if the
96         directory is empty; non-empty directories raise errors). The
97         directory can be safely deleted inside the block as well, if so
98         desired.
99
100         Note that the object returned is not a string and does not support all of the string
101         methods. If you need a string, coerce the object to a string and go from there.
102         """
103         class TemporaryDirectory(object):
104             def __init__(self, **kwargs):
105                 self._kwargs = kwargs
106                 self._directory_path = tempfile.mkdtemp(**self._kwargs)
107
108             def __str__(self):
109                 return self._directory_path
110
111             def __enter__(self):
112                 return self._directory_path
113
114             def __exit__(self, type, value, traceback):
115                 # Only self-delete if necessary.
116
117                 # FIXME: Should we delete non-empty directories?
118                 if os.path.exists(self._directory_path):
119                     os.rmdir(self._directory_path)
120
121         return TemporaryDirectory(**kwargs)
122
123     def maybe_make_directory(self, *path):
124         """Create the specified directory if it doesn't already exist."""
125         try:
126             os.makedirs(self.join(*path))
127         except OSError, e:
128             if e.errno != errno.EEXIST:
129                 raise
130
131     def move(self, src, dest):
132         shutil.move(src, dest)
133
134     def normpath(self, path):
135         """Wraps os.path.normpath()."""
136         return os.path.normpath(path)
137
138     def open_binary_tempfile(self, suffix):
139         """Create, open, and return a binary temp file. Returns a tuple of the file and the name."""
140         temp_fd, temp_name = tempfile.mkstemp(suffix)
141         f = os.fdopen(temp_fd, 'wb')
142         return f, temp_name
143
144     def read_binary_file(self, path):
145         """Return the contents of the file at the given path as a byte string."""
146         with file(path, 'rb') as f:
147             return f.read()
148
149     def read_text_file(self, path):
150         """Return the contents of the file at the given path as a Unicode string.
151
152         The file is read assuming it is a UTF-8 encoded file with no BOM."""
153         with codecs.open(path, 'r', 'utf8') as f:
154             return f.read()
155
156     class _WindowsError(exceptions.OSError):
157         """Fake exception for Linux and Mac."""
158         pass
159
160     def remove(self, path, osremove=os.remove):
161         """On Windows, if a process was recently killed and it held on to a
162         file, the OS will hold on to the file for a short while.  This makes
163         attempts to delete the file fail.  To work around that, this method
164         will retry for a few seconds until Windows is done with the file."""
165         try:
166             exceptions.WindowsError
167         except AttributeError:
168             exceptions.WindowsError = FileSystem._WindowsError
169
170         retry_timeout_sec = 3.0
171         sleep_interval = 0.1
172         while True:
173             try:
174                 osremove(path)
175                 return True
176             except exceptions.WindowsError, e:
177                 time.sleep(sleep_interval)
178                 retry_timeout_sec -= sleep_interval
179                 if retry_timeout_sec < 0:
180                     raise e
181
182     def rmtree(self, path):
183         """Delete the directory rooted at path, empty or no."""
184         shutil.rmtree(path, ignore_errors=True)
185
186     def read_binary_file(self, path):
187         """Return the contents of the file at the given path as a byte string."""
188         with file(path, 'rb') as f:
189             return f.read()
190
191     def read_text_file(self, path):
192         """Return the contents of the file at the given path as a Unicode string.
193
194         The file is read assuming it is a UTF-8 encoded file with no BOM."""
195         with codecs.open(path, 'r', 'utf8') as f:
196             return f.read()
197
198     def splitext(self, path):
199         """Return (dirname + os.sep + basename, '.' + ext)"""
200         return os.path.splitext(path)
201
202     def write_binary_file(self, path, contents):
203         """Write the contents to the file at the given location."""
204         with file(path, 'wb') as f:
205             f.write(contents)
206
207     def write_text_file(self, path, contents):
208         """Write the contents to the file at the given location.
209
210         The file is written encoded as UTF-8 with no BOM."""
211         with codecs.open(path, 'w', 'utf8') as f:
212             f.write(contents)