Build fix attempt after r105543.
[WebKit-https.git] / Tools / Scripts / webkitpy / common / net / file_uploader.py
1 #!/usr/bin/env python
2 # Copyright (C) 2010 Google Inc. All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met:
7 #
8 #     * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 #     * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
13 # distribution.
14 #     * Neither the name of Google Inc. nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 from __future__ import with_statement
31
32 import codecs
33 import mimetypes
34 import socket
35 import urllib2
36
37 from webkitpy.common.net.networktransaction import NetworkTransaction
38
39
40 def get_mime_type(filename):
41     return mimetypes.guess_type(filename)[0] or 'application/octet-stream'
42
43
44 # FIXME: Rather than taking tuples, this function should take more structured data.
45 def _encode_multipart_form_data(fields, files):
46     """Encode form fields for multipart/form-data.
47
48     Args:
49       fields: A sequence of (name, value) elements for regular form fields.
50       files: A sequence of (name, filename, value) elements for data to be
51              uploaded as files.
52     Returns:
53       (content_type, body) ready for httplib.HTTP instance.
54
55     Source:
56       http://code.google.com/p/rietveld/source/browse/trunk/upload.py
57     """
58     BOUNDARY = '-M-A-G-I-C---B-O-U-N-D-A-R-Y-'
59     CRLF = '\r\n'
60     lines = []
61
62     for key, value in fields:
63         lines.append('--' + BOUNDARY)
64         lines.append('Content-Disposition: form-data; name="%s"' % key)
65         lines.append('')
66         if isinstance(value, unicode):
67             value = value.encode('utf-8')
68         lines.append(value)
69
70     for key, filename, value in files:
71         lines.append('--' + BOUNDARY)
72         lines.append('Content-Disposition: form-data; name="%s"; filename="%s"' % (key, filename))
73         lines.append('Content-Type: %s' % get_mime_type(filename))
74         lines.append('')
75         if isinstance(value, unicode):
76             value = value.encode('utf-8')
77         lines.append(value)
78
79     lines.append('--' + BOUNDARY + '--')
80     lines.append('')
81     body = CRLF.join(lines)
82     content_type = 'multipart/form-data; boundary=%s' % BOUNDARY
83     return content_type, body
84
85
86 class FileUploader(object):
87     def __init__(self, url, timeout_seconds):
88         self._url = url
89         self._timeout_seconds = timeout_seconds
90
91     def upload_single_text_file(self, filesystem, content_type, filename):
92         return self._upload_data(content_type, filesystem.read_text_file(filename))
93
94     def upload_as_multipart_form_data(self, filesystem, files, attrs):
95         file_objs = []
96         for filename, path in files:
97             # FIXME: We should talk to the filesytem via a Host object.
98             file_objs.append(('file', filename, filesystem.read_text_file(filename)))
99
100         # FIXME: We should use the same variable names for the formal and actual parameters.
101         content_type, data = _encode_multipart_form_data(attrs, file_objs)
102         return self._upload_data(content_type, data)
103
104     def _upload_data(self, content_type, data):
105         def callback():
106             request = urllib2.Request(self._url, data, {"Content-Type": content_type})
107             return urllib2.urlopen(request)
108
109         orig_timeout = socket.getdefaulttimeout()
110         response = None
111         try:
112             # FIXME: We shouldn't mutate global static state.
113             socket.setdefaulttimeout(self._timeout_seconds)
114             response = NetworkTransaction(timeout_seconds=self._timeout_seconds).run(callback)
115         finally:
116             socket.setdefaulttimeout(orig_timeout)
117             return response