openerp/service/http_server.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright P. Christeas <p_christ@hol.gr> 2008-2010
   4 # Copyright 2010 OpenERP SA. (http://www.openerp.com)
   5 #
   6 #
   7 # WARNING: This program as such is intended to be used by professional
   8 # programmers who take the whole responsability of assessing all potential
   9 # consequences resulting from its eventual inadequacies and bugs
  10 # End users who are looking for a ready-to-use solution with commercial
  11 # garantees and support are strongly adviced to contract a Free Software
  12 # Service Company
  13 #
  14 # This program is Free Software; you can redistribute it and/or
  15 # modify it under the terms of the GNU General Public License
  16 # as published by the Free Software Foundation; either version 2
  17 # of the License, or (at your option) any later version.
  18 #
  19 # This program is distributed in the hope that it will be useful,
  20 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 # GNU General Public License for more details.
  23 #
  24 # You should have received a copy of the GNU General Public License
  25 # along with this program; if not, write to the Free Software
  26 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  27 ###############################################################################
  28
  29 #.apidoc title: HTTP and XML-RPC Server
  30
  31 """ This module offers the family of HTTP-based servers. These are not a single
  32     class/functionality, but a set of network stack layers, implementing
  33     extendable HTTP protocols.
  34
  35     The OpenERP server defines a single instance of a HTTP server, listening at
  36     the standard 8069, 8071 ports (well, it is 2 servers, and ports are
  37     configurable, of course). This "single" server then uses a `MultiHTTPHandler`
  38     to dispatch requests to the appropriate channel protocol, like the XML-RPC,
  39     static HTTP, DAV or other.
  40 """
  41
  42 import base64
  43 import posixpath
  44 import urllib
  45 import os
  46 import logging
  47 from SimpleXMLRPCServer import SimpleXMLRPCDispatcher
  48
  49 from websrv_lib import *
  50 import openerp.netsvc as netsvc
  51 import openerp.tools as tools
  52
  53 try:
  54     import fcntl
  55 except ImportError:
  56     fcntl = None
  57
  58 try:
  59     from ssl import SSLError
  60 except ImportError:
  61     class SSLError(Exception): pass
  62
  63 _logger = logging.getLogger(__name__)
  64
  65 # TODO delete this for 6.2, it is still needed for 6.1.
  66 class HttpLogHandler:
  67     """ helper class for uniform log handling
  68     Please define self._logger at each class that is derived from this
  69     """
  70     _logger = None
  71
  72     def log_message(self, format, *args):
  73         self._logger.debug(format % args) # todo: perhaps other level
  74
  75     def log_error(self, format, *args):
  76         self._logger.error(format % args)
  77
  78     def log_exception(self, format, *args):
  79         self._logger.exception(format, *args)
  80
  81     def log_request(self, code='-', size='-'):
  82         self._logger.debug('"%s" %s %s',
  83             self.requestline, str(code), str(size))
  84
  85 class StaticHTTPHandler(HttpLogHandler, FixSendError, HttpOptions, HTTPHandler):
  86     _logger = logging.getLogger(__name__)
  87
  88     _HTTP_OPTIONS = { 'Allow': ['OPTIONS', 'GET', 'HEAD'] }
  89
  90     def __init__(self,request, client_address, server):
  91         HTTPHandler.__init__(self,request,client_address,server)
  92         document_root = tools.config.get('static_http_document_root', False)
  93         assert document_root, "Please specify static_http_document_root in configuration, or disable static-httpd!"
  94         self.__basepath = document_root
  95
  96     def translate_path(self, path):
  97         """Translate a /-separated PATH to the local filename syntax.
  98
  99         Components that mean special things to the local file system
 100         (e.g. drive or directory names) are ignored.  (XXX They should
 101         probably be diagnosed.)
 102
 103         """
 104         # abandon query parameters
 105         path = path.split('?',1)[0]
 106         path = path.split('#',1)[0]
 107         path = posixpath.normpath(urllib.unquote(path))
 108         words = path.split('/')
 109         words = filter(None, words)
 110         path = self.__basepath
 111         for word in words:
 112             if word in (os.curdir, os.pardir): continue
 113             path = os.path.join(path, word)
 114         return path
 115
 116 def init_static_http():
 117     if not tools.config.get('static_http_enable', False):
 118         return
 119
 120     document_root = tools.config.get('static_http_document_root', False)
 121     assert document_root, "Document root must be specified explicitly to enable static HTTP service (option --static-http-document-root)"
 122
 123     base_path = tools.config.get('static_http_url_prefix', '/')
 124
 125     reg_http_service(base_path, StaticHTTPHandler)
 126
 127     _logger.info("Registered HTTP dir %s for %s", document_root, base_path)
 128
 129 import security
 130
 131 class OpenERPAuthProvider(AuthProvider):
 132     """ Require basic authentication."""
 133     def __init__(self,realm='OpenERP User'):
 134         self.realm = realm
 135         self.auth_creds = {}
 136         self.auth_tries = 0
 137         self.last_auth = None
 138
 139     def authenticate(self, db, user, passwd, client_address):
 140         try:
 141             uid = security.login(db,user,passwd)
 142             if uid is False:
 143                 return False
 144             return (user, passwd, db, uid)
 145         except Exception,e:
 146             _logger.debug("Fail auth: %s" % e )
 147             return False
 148
 149     def checkRequest(self,handler,path, db=False):
 150         auth_str = handler.headers.get('Authorization',False)
 151         try:
 152             if not db:
 153                 db = handler.get_db_from_path(path)
 154         except Exception:
 155             if path.startswith('/'):
 156                 path = path[1:]
 157             psp= path.split('/')
 158             if len(psp)>1:
 159                 db = psp[0]
 160             else:
 161                 #FIXME!
 162                 _logger.info("Wrong path: %s, failing auth" %path)
 163                 raise AuthRejectedExc("Authorization failed. Wrong sub-path.")
 164         if self.auth_creds.get(db):
 165             return True
 166         if auth_str and auth_str.startswith('Basic '):
 167             auth_str=auth_str[len('Basic '):]
 168             (user,passwd) = base64.decodestring(auth_str).split(':')
 169             _logger.info("Found user=\"%s\", passwd=\"***\" for db=\"%s\"", user, db)
 170             acd = self.authenticate(db,user,passwd,handler.client_address)
 171             if acd != False:
 172                 self.auth_creds[db] = acd
 173                 self.last_auth = db
 174                 return True
 175         if self.auth_tries > 5:
 176             _logger.info("Failing authorization after 5 requests w/o password")
 177             raise AuthRejectedExc("Authorization failed.")
 178         self.auth_tries += 1
 179         raise AuthRequiredExc(atype='Basic', realm=self.realm)
 180
 181 #eof
 182
 183 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: