1 # Copyright (C) 2010 Chris Jerdonek (cjerdonek@webkit.org)
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions
6 # 1. Redistributions of source code must retain the above copyright
7 # notice, this list of conditions and the following disclaimer.
8 # 2. Redistributions in binary form must reproduce the above copyright
9 # notice, this list of conditions and the following disclaimer in the
10 # documentation and/or other materials provided with the distribution.
12 # THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND
13 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
15 # DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR
16 # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
18 # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
19 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
20 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
21 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 # This module is required for Python to treat this directory as a package.
25 """Autoinstalls third-party code required by WebKit."""
27 from __future__ import with_statement
33 from webkitpy.common.system.autoinstall import AutoInstaller
34 from webkitpy.common.system.filesystem import FileSystem
36 _THIRDPARTY_DIR = os.path.dirname(__file__)
37 _AUTOINSTALLED_DIR = os.path.join(_THIRDPARTY_DIR, "autoinstalled")
39 # Putting the autoinstall code into webkitpy/thirdparty/__init__.py
40 # ensures that no autoinstalling occurs until a caller imports from
41 # webkitpy.thirdparty. This is useful if the caller wants to configure
42 # logging prior to executing autoinstall code.
44 # FIXME: If any of these servers is offline, webkit-patch breaks (and maybe
45 # other scripts do, too). See <http://webkit.org/b/42080>.
47 # We put auto-installed third-party modules in this directory--
49 # webkitpy/thirdparty/autoinstalled
51 fs.maybe_make_directory(_AUTOINSTALLED_DIR)
53 init_path = fs.join(_AUTOINSTALLED_DIR, "__init__.py")
54 if not fs.exists(init_path):
55 fs.write_text_file(init_path, "")
57 readme_path = fs.join(_AUTOINSTALLED_DIR, "README")
58 if not fs.exists(readme_path):
59 fs.write_text_file(readme_path,
60 "This directory is auto-generated by WebKit and is "
61 "safe to delete.\nIt contains needed third-party Python "
62 "packages automatically downloaded from the web.")
65 class AutoinstallImportHook(object):
66 def __init__(self, filesystem=None):
67 self._fs = filesystem or FileSystem()
69 def find_module(self, fullname, path):
70 # This method will run before each import. See http://www.python.org/dev/peps/pep-0302/
71 if '.autoinstalled' not in fullname:
74 if '.mechanize' in fullname:
75 self._install_mechanize()
76 elif '.pep8' in fullname:
78 elif '.eliza' in fullname:
80 elif '.irc' in fullname:
82 elif '.pywebsocket' in fullname:
83 self._install_pywebsocket()
84 elif '.buildbot' in fullname:
85 self._install_buildbot()
87 def _install_mechanize(self):
88 # The mechanize package uses ClientForm, for example, in _html.py.
89 # Since mechanize imports ClientForm in the following way,
91 # > import sgmllib, ClientForm
93 # the search path needs to include ClientForm. We put ClientForm in
94 # its own directory so that we can include it in the search path
95 # without including other modules as a side effect.
96 clientform_dir = self._fs.join(_AUTOINSTALLED_DIR, "clientform")
97 installer = AutoInstaller(append_to_search_path=True, target_dir=clientform_dir)
98 installer.install(url="http://pypi.python.org/packages/source/C/ClientForm/ClientForm-0.2.10.zip",
99 url_subpath="ClientForm.py")
101 self._install("http://pypi.python.org/packages/source/m/mechanize/mechanize-0.2.4.zip",
104 def _install_pep8(self):
105 self._install("http://pypi.python.org/packages/source/p/pep8/pep8-0.5.0.tar.gz#md5=512a818af9979290cd619cce8e9c2e2b",
106 "pep8-0.5.0/pep8.py")
108 # autoinstalled.buildbot is used by BuildSlaveSupport/build.webkit.org-config/mastercfg_unittest.py
109 # and should ideally match the version of BuildBot used at build.webkit.org.
110 def _install_buildbot(self):
111 # The buildbot package uses jinja2, for example, in buildbot/status/web/base.py.
112 # buildbot imports jinja2 directly (as though it were installed on the system),
113 # so the search path needs to include jinja2. We put jinja2 in
114 # its own directory so that we can include it in the search path
115 # without including other modules as a side effect.
116 jinja_dir = self._fs.join(_AUTOINSTALLED_DIR, "jinja2")
117 installer = AutoInstaller(append_to_search_path=True, target_dir=jinja_dir)
118 installer.install(url="http://pypi.python.org/packages/source/J/Jinja2/Jinja2-2.6.tar.gz#md5=1c49a8825c993bfdcf55bb36897d28a2",
119 url_subpath="Jinja2-2.6/jinja2")
121 self._install("http://pypi.python.org/packages/source/b/buildbot/buildbot-0.8.4p2.tar.gz#md5=7597d945724c80c0ab476e833a1026cb", "buildbot-0.8.4p2/buildbot")
123 def _install_eliza(self):
124 installer = AutoInstaller(target_dir=_AUTOINSTALLED_DIR)
125 installer.install(url="http://www.adambarth.com/webkit/eliza",
126 target_name="eliza.py")
128 def _install_irc(self):
129 # Since irclib and ircbot are two top-level packages, we need to import
130 # them separately. We group them into an irc package for better
131 # organization purposes.
132 irc_dir = self._fs.join(_AUTOINSTALLED_DIR, "irc")
133 installer = AutoInstaller(target_dir=irc_dir)
134 installer.install(url="http://downloads.sourceforge.net/project/python-irclib/python-irclib/0.4.8/python-irclib-0.4.8.zip",
135 url_subpath="irclib.py")
136 installer.install(url="http://downloads.sourceforge.net/project/python-irclib/python-irclib/0.4.8/python-irclib-0.4.8.zip",
137 url_subpath="ircbot.py")
139 def _install_pywebsocket(self):
140 pywebsocket_dir = self._fs.join(_AUTOINSTALLED_DIR, "pywebsocket")
141 installer = AutoInstaller(target_dir=pywebsocket_dir)
142 installer.install(url="http://pywebsocket.googlecode.com/files/mod_pywebsocket-0.6b5.tar.gz",
143 url_subpath="pywebsocket-0.6b5/src/mod_pywebsocket")
145 def _install(self, url, url_subpath):
146 installer = AutoInstaller(target_dir=_AUTOINSTALLED_DIR)
147 installer.install(url=url, url_subpath=url_subpath)
150 sys.meta_path.append(AutoinstallImportHook())