2 # -*- encoding: utf-8 -*-
4 # Copyright P. Christeas <p_christ@hol.gr> 2008,2009
5 # Copyright OpenERP SA. (http://www.openerp.com) 2010
8 # WARNING: This program as such is intended to be used by professional
9 # programmers who take the whole responsability of assessing all potential
10 # consequences resulting from its eventual inadequacies and bugs
11 # End users who are looking for a ready-to-use solution with commercial
12 # garantees and support are strongly adviced to contract a Free Software
15 # This program is Free Software; you can redistribute it and/or
16 # modify it under the terms of the GNU General Public License
17 # as published by the Free Software Foundation; either version 2
18 # of the License, or (at your option) any later version.
20 # This program is distributed in the hope that it will be useful,
21 # but WITHOUT ANY WARRANTY; without even the implied warranty of
22 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 # GNU General Public License for more details.
25 # You should have received a copy of the GNU General Public License
26 # along with this program; if not, write to the Free Software
27 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 ###############################################################################
30 """ A trivial HTTP/WebDAV client, used for testing the server
32 # code taken from the 'http-client.py' script:
33 # http://git.hellug.gr/?p=xrg/openerp;a=history;f=tests/http-client.py;hb=refs/heads/xrg-60
37 import xml.dom.minidom
41 from openerp.tools import config
42 from xmlrpclib import Transport, ProtocolError
45 from openerp import SUPERUSER_ID
47 _logger = logging.getLogger(__name__)
49 class HTTP11(httplib.HTTP):
51 _http_vsn_str = 'HTTP/1.1'
53 class PersistentTransport(Transport):
54 """Handles an HTTP transaction to an XML-RPC server, persistently."""
56 def __init__(self, use_datetime=0):
57 self._use_datetime = use_datetime
59 log.debug("Using persistent transport")
61 def make_connection(self, host):
62 # create a HTTP connection object from a host descriptor
63 if not self._http.has_key(host):
64 host, extra_headers, x509 = self.get_host_info(host)
65 self._http[host] = HTTP11(host)
66 _logger.debug("New connection to %s", host)
67 return self._http[host]
69 def get_host_info(self, host):
70 host, extra_headers, x509 = Transport.get_host_info(self,host)
71 if extra_headers == None:
74 extra_headers.append( ( 'Connection', 'keep-alive' ))
76 return host, extra_headers, x509
78 def _parse_response(self, file, sock, response):
79 """ read response from input file/socket, and parse it
80 We are persistent, so it is important to only parse
81 the right amount of input
84 p, u = self.getparser()
86 if response.msg.get('content-encoding') == 'gzip':
87 gzdata = StringIO.StringIO()
88 while not response.isclosed():
89 rdata = response.read(1024)
94 rbuffer = gzip.GzipFile(mode='rb', fileobj=gzdata)
96 respdata = rbuffer.read()
101 while not response.isclosed():
102 rdata = response.read(1024)
112 def request(self, host, handler, request_body, verbose=0):
113 # issue XML-RPC request
115 h = self.make_connection(host)
119 self.send_request(h, handler, request_body)
120 self.send_host(h, host)
121 self.send_user_agent(h)
122 self.send_content(h, request_body)
124 resp = h._conn.getresponse()
125 # TODO: except BadStatusLine, e:
127 errcode, errmsg, headers = resp.status, resp.reason, resp.msg
137 self.verbose = verbose
141 except AttributeError:
144 return self._parse_response(h.getfile(), sock, resp)
146 class CompressedTransport(PersistentTransport):
147 def send_content(self, connection, request_body):
148 connection.putheader("Content-Type", "text/xml")
150 if len(request_body) > 512 or True:
151 buffer = StringIO.StringIO()
152 output = gzip.GzipFile(mode='wb', fileobj=buffer)
153 output.write(request_body)
156 request_body = buffer.getvalue()
157 connection.putheader('Content-Encoding', 'gzip')
159 connection.putheader("Content-Length", str(len(request_body)))
160 connection.putheader("Accept-Encoding",'gzip')
161 connection.endheaders()
163 connection.send(request_body)
165 def send_request(self, connection, handler, request_body):
166 connection.putrequest("POST", handler, skip_accept_encoding=1)
168 class SafePersistentTransport(PersistentTransport):
169 def make_connection(self, host):
170 # create a HTTP connection object from a host descriptor
171 if not self._http.has_key(host):
172 host, extra_headers, x509 = self.get_host_info(host)
173 self._http[host] = httplib.HTTPS(host, None, **(x509 or {}))
174 _logger.debug("New connection to %s", host)
175 return self._http[host]
177 class AuthClient(object):
178 def getAuth(self, atype, realm):
179 raise NotImplementedError("Cannot authenticate for %s" % atype)
181 def resolveFailedRealm(self, realm):
182 """ Called when, using a known auth type, the realm is not in cache
184 raise NotImplementedError("Cannot authenticate for realm %s" % realm)
186 class BasicAuthClient(AuthClient):
188 self._realm_dict = {}
190 def getAuth(self, atype, realm):
191 if atype != 'Basic' :
192 return super(BasicAuthClient,self).getAuth(atype, realm)
194 if not self._realm_dict.has_key(realm):
195 _logger.debug("realm dict: %r", self._realm_dict)
196 _logger.debug("missing key: \"%s\"" % realm)
197 self.resolveFailedRealm(realm)
198 return 'Basic '+ self._realm_dict[realm]
200 def addLogin(self, realm, username, passwd):
201 """ Add some known username/password for a specific login.
202 This function should be called once, for each realm
203 that we want to authenticate against
206 auths = base64.encodestring(username + ':' + passwd)
207 if auths[-1] == "\n":
209 self._realm_dict[realm] = auths
211 class addAuthTransport:
212 """ Intermediate class that authentication algorithm to http transport
215 def setAuthClient(self, authobj):
216 """ Set the authentication client object.
217 This method must be called before any request is issued, that
218 would require http authentication
220 assert isinstance(authobj, AuthClient)
221 self._auth_client = authobj
224 def request(self, host, handler, request_body, verbose=0):
225 # issue XML-RPC request
227 h = self.make_connection(host)
236 self.send_request(h, handler, request_body)
237 self.send_host(h, host)
238 self.send_user_agent(h)
240 # This line will bork if self.setAuthClient has not
241 # been issued. That is a programming error, fix your code!
242 auths = self._auth_client.getAuth(atype, realm)
243 _logger.debug("sending authorization: %s", auths)
244 h.putheader('Authorization', auths)
245 self.send_content(h, request_body)
247 resp = h._conn.getresponse()
248 # except BadStatusLine, e:
251 if resp.status == 401:
252 if 'www-authenticate' in resp.msg:
253 (atype,realm) = resp.msg.getheader('www-authenticate').split(' ',1)
256 log.warning("Why have data on a 401 auth. message?")
257 if realm.startswith('realm="') and realm.endswith('"'):
259 _logger.debug("Resp: %r %r", resp.version,resp.isclosed(), resp.will_close)
260 _logger.debug("Want to do auth %s for realm %s", atype, realm)
262 raise ProtocolError(host+handler, 403,
263 "Unknown authentication method: %s" % atype, resp.msg)
264 continue # with the outer while loop
266 raise ProtocolError(host+handler, 403,
267 'Server-incomplete authentication', resp.msg)
269 if resp.status != 200:
270 raise ProtocolError( host + handler,
271 resp.status, resp.reason, resp.msg )
273 self.verbose = verbose
277 except AttributeError:
280 return self._parse_response(h.getfile(), sock, resp)
282 raise ProtocolError(host+handler, 403, "No authentication.",'')
284 class PersistentAuthTransport(addAuthTransport,PersistentTransport):
287 class PersistentAuthCTransport(addAuthTransport,CompressedTransport):
290 class HTTPSConnection(httplib.HTTPSConnection):
293 "Connect to a host on a given (SSL) port. check the certificate"
296 if HTTPSConnection.certs_file:
297 ca_certs = HTTPSConnection.certs_file
298 cert_reqs = ssl.CERT_REQUIRED
301 cert_reqs = ssl.CERT_NONE
302 sock = socket.create_connection((self.host, self.port), self.timeout)
303 self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file,
308 def getpeercert(self):
312 cert = self.sock.getpeercert()
314 cert = ssl.get_server_certificate((self.host,self.port),
315 ssl_version=ssl.PROTOCOL_SSLv23 )
316 lf = (len(ssl.PEM_FOOTER)+1)
317 if cert[0-lf] != '\n':
318 cert = cert[:0-lf]+'\n'+cert[0-lf:]
319 _logger.debug("len-footer: %s cert: %r", lf, cert[0-lf])
324 class DAVClient(object):
325 """An instance of a WebDAV client, connected to the OpenERP server
328 def __init__(self, user=None, passwd=None, dbg=0, use_ssl=False, useragent=False, timeout=None):
330 self.host = config.get_misc('httpsd', 'interface', False)
331 self.port = config.get_misc('httpsd', 'port', 8071)
333 self.host = config.get('xmlrpcs_interface')
334 self.port = config.get('xmlrpcs_port')
336 self.host = config.get_misc('httpd', 'interface')
337 self.port = config.get_misc('httpd', 'port', 8069)
339 self.host = config.get('xmlrpc_interface')
340 self.port = config.get('xmlrpc_port') or self.port
341 if self.host == '0.0.0.0' or not self.host:
342 self.host = '127.0.0.1'
343 self.port = int(self.port)
344 if not config.get_misc('webdav','enable',True):
345 raise Exception("WebDAV is disabled, cannot continue")
346 self.davpath = '/' + config.get_misc('webdav','vdir','webdav')
350 self.timeout = timeout or 5.0 # seconds, tests need to respond pretty fast!
353 self.set_useragent(useragent)
355 def get_creds(self, obj, cr, uid):
356 """Read back the user credentials from cr, uid
358 @param obj is any orm object, in order to use its pool
359 @param uid is the numeric id, which we will try to reverse resolve
361 note: this is a hackish way to get the credentials. It is expected
362 to break if "base_crypt" is used.
364 ruob = obj.pool.get('res.users')
365 res = ruob.read(cr, SUPERUSER_ID, [uid,], ['login', 'password'])
366 assert res, "uid %s not found" % uid
367 self.user = res[0]['login']
368 self.passwd = res[0]['password']
369 if self.passwd.startswith('$1$'):
370 # md5 by base crypt. We cannot decode, wild guess
371 # that passwd = login
372 self.passwd = self.user
375 def set_useragent(self, uastr):
376 """ Set the user-agent header to something meaningful.
377 Some shorthand names will be replaced by stock strings.
379 if uastr in ('KDE4', 'Korganizer'):
380 self.hdrs['User-Agent'] = "Mozilla/5.0 (compatible; Konqueror/4.4; Linux) KHTML/4.4.3 (like Gecko)"
381 elif uastr == 'iPhone3':
382 self.hdrs['User-Agent'] = "DAVKit/5.0 (765); iCalendar/5.0 (79); iPhone/4.1 8B117"
383 elif uastr == "MacOS":
384 self.hdrs['User-Agent'] = "WebDAVFS/1.8 (01808000) Darwin/9.8.0 (i386)"
386 self.hdrs['User-Agent'] = uastr
388 def _http_request(self, path, method='GET', hdrs=None, body=None):
393 hdrs.update(self.hdrs)
394 _logger.debug("Getting %s http://%s:%d/%s", method, self.host, self.port, path)
395 conn = httplib.HTTPConnection(self.host, port=self.port, timeout=self.timeout)
396 conn.set_debuglevel(dbg)
399 if not hdrs.has_key('Connection'):
400 hdrs['Connection']= 'keep-alive'
401 conn.request(method, path, body, hdrs )
403 r1 = conn.getresponse()
404 except httplib.BadStatusLine, bsl:
405 log.warning("Bad status line: %s", bsl.line)
406 raise Exception('Bad status line.')
407 if r1.status == 401: # and r1.headers:
408 if 'www-authenticate' in r1.msg:
409 (atype,realm) = r1.msg.getheader('www-authenticate').split(' ',1)
412 raise Exception('Must auth, have no user/pass!')
413 _logger.debug("Ver: %s, closed: %s, will close: %s", r1.version,r1.isclosed(), r1.will_close)
414 _logger.debug("Want to do auth %s for realm %s", atype, realm)
415 if atype == 'Basic' :
416 auths = base64.encodestring(self.user + ':' + self.passwd)
417 if auths[-1] == "\n":
419 hdrs['Authorization']= 'Basic '+ auths
421 conn.request(method, path, body, hdrs )
422 r1 = conn.getresponse()
424 raise Exception("Unknown auth type %s" %atype)
426 _logger.warning("Got 401, cannot auth")
427 raise Exception('No auth')
429 _logger.debug("Reponse: %s %s",r1.status, r1.reason)
432 _logger.debug("Body:\n%s\nEnd of body", data1)
434 ctype = r1.msg.getheader('content-type')
435 if ctype and ';' in ctype:
436 ctype, encoding = ctype.split(';',1)
437 if ctype == 'text/xml':
438 doc = xml.dom.minidom.parseString(data1)
439 _logger.debug("XML Body:\n %s", doc.toprettyxml(indent="\t"))
441 _logger.warning("Cannot print XML.", exc_info=True)
444 return r1.status, r1.msg, data1
446 def _assert_headers(self, expect, msg):
447 """ Assert that the headers in msg contain the expect values
449 for k, v in expect.items():
450 hval = msg.getheader(k)
452 raise AssertionError("Header %s not defined in http response" % k)
453 if isinstance(v, (list, tuple)):
455 hits = map(str.strip, hval.split(delim))
461 raise AssertionError("HTTP header \"%s\" is missing: %s" %(k, ', '.join(mvits)))
463 if hval.strip() != v.strip():
464 raise AssertionError("HTTP header \"%s: %s\"" % (k, hval))
466 def gd_options(self, path='*', expect=None):
467 """ Test the http options functionality
468 If a dictionary is defined in expect, those options are
472 path = self.davpath + path
473 hdrs = { 'Content-Length': 0
475 s, m, d = self._http_request(path, method='OPTIONS', hdrs=hdrs)
476 assert s == 200, "Status: %r" % s
477 assert 'OPTIONS' in m.getheader('Allow')
478 _logger.debug('Options: %r', m.getheader('Allow'))
481 self._assert_headers(expect, m)
483 def _parse_prop_response(self, data):
484 """ Parse a propfind/propname response
488 for node in node.childNodes:
489 if node.nodeType == node.TEXT_NODE:
493 def getElements(node, namespaces=None, strict=False):
494 for cnod in node.childNodes:
495 if cnod.nodeType != node.ELEMENT_NODE:
497 _logger.debug("Found %r inside <%s>", cnod, node.tagName)
499 if namespaces and (cnod.namespaceURI not in namespaces):
500 _logger.debug("Ignoring <%s> in <%s>", cnod.tagName, node.localName)
504 nod = xml.dom.minidom.parseString(data)
505 nod_r = nod.documentElement
507 assert nod_r.localName == 'multistatus', nod_r.tagName
508 for resp in nod_r.getElementsByTagNameNS('DAV:', 'response'):
512 for cno in getElements(resp, namespaces=['DAV:',]):
513 if cno.localName == 'href':
514 assert href is None, "Second href in same response"
516 elif cno.localName == 'propstat':
517 for pno in getElements(cno, namespaces=['DAV:',]):
519 if pno.localName == 'prop':
520 for prop in getElements(pno):
522 tval = getText(prop).strip()
523 val = tval or (True, rstatus or status)
524 if prop.namespaceURI == 'DAV:' and prop.localName == 'resourcetype':
526 for rte in getElements(prop, namespaces=['DAV:',]):
527 # Note: we only look at DAV:... elements, we
528 # actually expect only one DAV:collection child
530 res_nss.setdefault(prop.namespaceURI,{})[key] = val
531 elif pno.localName == 'status':
533 htver, sta, msg = rstr.split(' ', 3)
534 assert htver == 'HTTP/1.1'
537 _logger.debug("What is <%s> inside a <propstat>?", pno.tagName)
540 _logger.debug("Unknown node: %s", cno.tagName)
542 res.setdefault(href,[]).append((status, res_nss))
546 def gd_propfind(self, path, props=None, depth=0):
548 propstr = '<allprop/>'
554 if isinstance(p, tuple):
556 if ns is None or ns == 'DAV:':
557 propstr += '<%s/>' % p
559 propstr += '<ns%d:%s xmlns:ns%d="%s" />' %(nscount, p, nscount, ns)
563 body="""<?xml version="1.0" encoding="utf-8"?>
564 <propfind xmlns="DAV:">%s</propfind>""" % propstr
565 hdrs = { 'Content-Type': 'text/xml; charset=utf-8',
566 'Accept': 'text/xml',
570 s, m, d = self._http_request(self.davpath + path, method='PROPFIND',
571 hdrs=hdrs, body=body)
572 assert s == 207, "Bad status: %s" % s
573 ctype = m.getheader('Content-Type').split(';',1)[0]
574 assert ctype == 'text/xml', m.getheader('Content-Type')
575 res = self._parse_prop_response(d)
578 res = res.values()[0]
584 def gd_propname(self, path, depth=0):
585 body="""<?xml version="1.0" encoding="utf-8"?>
586 <propfind xmlns="DAV:"><propname/></propfind>"""
587 hdrs = { 'Content-Type': 'text/xml; charset=utf-8',
588 'Accept': 'text/xml',
591 s, m, d = self._http_request(self.davpath + path, method='PROPFIND',
592 hdrs=hdrs, body=body)
593 assert s == 207, "Bad status: %s" % s
594 ctype = m.getheader('Content-Type').split(';',1)[0]
595 assert ctype == 'text/xml', m.getheader('Content-Type')
596 res = self._parse_prop_response(d)
599 res = res.values()[0]
604 def gd_getetag(self, path, depth=0):
605 return self.gd_propfind(path, props=['getetag',], depth=depth)
607 def gd_lsl(self, path):
608 """ Return a list of 'ls -l' kind of data for a folder
610 This is based on propfind.
613 lspairs = [ ('name', 'displayname', 'n/a'), ('size', 'getcontentlength', '0'),
614 ('type', 'resourcetype', '----------'), ('uid', 'owner', 'nobody'),
615 ('gid', 'group', 'nogroup'), ('mtime', 'getlastmodified', 'n/a'),
616 ('mime', 'getcontenttype', 'application/data'), ]
618 propnames = [ l[1] for l in lspairs]
619 propres = self.gd_propfind(path, props=propnames, depth=1)
622 for href, pr in propres.items():
625 davprops = nsdic['DAV:']
628 if lsp[1] in davprops:
629 if lsp[1] == 'resourcetype':
630 if davprops[lsp[1]] == 'collection':
631 lsline[lsp[0]] = 'dr-xr-x---'
633 lsline[lsp[0]] = '-r-xr-x---'
635 lsline[lsp[0]] = davprops[lsp[1]]
636 elif st in (404, 403):
638 if lsp[1] in davprops:
639 lsline[lsp[0]] = lsp[2]
641 _logger.debug("Strange status: %s", st)
647 def gd_get(self, path, crange=None, mime=None, compare=None):
648 """ HTTP GET for path, supporting Partial ranges
650 hdrs = { 'Accept': mime or '*/*', }
652 if isinstance(crange, tuple):
654 if not isinstance(crange, list):
655 raise TypeError("Range must be a tuple or list of tuples.")
658 rs.append('%d-%d' % r)
659 hdrs['Range'] = 'bytes='+ (','.join(rs))
660 s, m, d = self._http_request(self.davpath + path, method='GET', hdrs=hdrs)
661 assert s in (200, 206), "Bad status: %s" % s
662 ctype = m.getheader('Content-Type')
663 if ctype and ';' in ctype:
664 ctype = ctype.split(';',1)[0]
666 assert ctype == mime, m.getheader('Content-Type')
668 rrh = m.getheader('Content-Range')
670 assert rrh.startswith('bytes '), rrh
671 rrh=rrh[6:].split('/',1)[0]
672 rrange = map(int, rrh.split('-',1))
674 # we need to compare the returned data with that of compare
675 fd = open(compare, 'rb')
680 raise NotImplementedError
683 assert d2 == d, "Data does not match"
684 return ctype, rrange, d
686 def gd_put(self, path, body=None, srcpath=None, mime=None, noclobber=False):
688 @param noclobber will prevent overwritting a resource (If-None-Match)
689 @param mime will set the content-type
692 if not (body or srcpath):
693 raise ValueError("PUT must have something to send.")
694 if (not body) and srcpath:
695 fd = open(srcpath, 'rb')
699 hdrs['Content-Type'] = mime
701 hdrs['If-None-Match'] = '*'
702 s, m, d = self._http_request(self.davpath + path, method='PUT',
703 hdrs=hdrs, body=body)
704 assert s == (201), "Bad status: %s" % s
705 etag = m.getheader('ETag')
708 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: