initial import
[vuplus_webkit] / Tools / Scripts / webkitpy / common / system / zipfileset.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
5 # are met:
6 #
7 # 1.  Redistributions of source code must retain the above copyright
8 #     notice, this list of conditions and the following disclaimer.
9 # 2.  Redistributions in binary form must reproduce the above copyright
10 #     notice, this list of conditions and the following disclaimer in the
11 #     documentation and/or other materials provided with the distribution.
12 #
13 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
14 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
20 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23
24 import urllib
25 import zipfile
26
27 from webkitpy.common.net.networktransaction import NetworkTransaction
28 from webkitpy.common.system.fileset import FileSetFileHandle
29 from webkitpy.common.system.filesystem import FileSystem
30
31
32 class ZipFileSet(object):
33     """The set of files in a zip file that resides at a URL (local or remote)"""
34     def __init__(self, zip_url, filesystem=None, zip_factory=None):
35         self._zip_url = zip_url
36         self._temp_file = None
37         self._zip_file = None
38         self._filesystem = filesystem or FileSystem()
39         self._zip_factory = zip_factory or self._retrieve_zip_file
40
41     def _retrieve_zip_file(self, zip_url):
42         temp_file = NetworkTransaction().run(lambda: urllib.urlretrieve(zip_url)[0])
43         return (temp_file, zipfile.ZipFile(temp_file))
44
45     def _load(self):
46         if self._zip_file is None:
47             self._temp_file, self._zip_file = self._zip_factory(self._zip_url)
48
49     def open(self, filename):
50         self._load()
51         return FileSetFileHandle(self, filename, self._filesystem)
52
53     def close(self):
54         if self._temp_file:
55             self._filesystem.remove(self._temp_file)
56             self._temp_file = None
57
58     def namelist(self):
59         self._load()
60         return self._zip_file.namelist()
61
62     def read(self, filename):
63         self._load()
64         return self._zip_file.read(filename)
65
66     def extract(self, filename, path):
67         self._load()
68         self._zip_file.extract(filename, path)
69
70     def delete(self, filename):
71         raise Exception("Can't delete from a ZipFileSet.")