573 lines
20 KiB
Python
573 lines
20 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
##############################################################################
|
|
#
|
|
# OpenERP, Open Source Management Solution
|
|
# Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>). All Rights Reserved
|
|
# The refactoring about the OpenSSL support come from Tryton
|
|
# Copyright (C) 2007-2009 Cédric Krier.
|
|
# Copyright (C) 2007-2009 Bertrand Chenal.
|
|
# Copyright (C) 2008 B2CK SPRL.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
##############################################################################
|
|
|
|
import SimpleXMLRPCServer
|
|
import SocketServer
|
|
import logging
|
|
import logging.handlers
|
|
import os
|
|
import signal
|
|
import socket
|
|
import sys
|
|
import threading
|
|
import time
|
|
import xmlrpclib
|
|
import release
|
|
|
|
class Service(object):
|
|
""" Base class for *Local* services
|
|
|
|
Functionality here is trusted, no authentication.
|
|
"""
|
|
_services = {}
|
|
def __init__(self, name, audience=''):
|
|
Service._services[name] = self
|
|
self.__name = name
|
|
self._methods = {}
|
|
|
|
def joinGroup(self, name):
|
|
raise Exception("No group for local services")
|
|
#GROUPS.setdefault(name, {})[self.__name] = self
|
|
|
|
def service_exist(self,name):
|
|
return Service._services.has_key(name)
|
|
|
|
def exportMethod(self, method):
|
|
if callable(method):
|
|
self._methods[method.__name__] = method
|
|
|
|
def abortResponse(self, error, description, origin, details):
|
|
if not tools.config['debug_mode']:
|
|
raise Exception("%s -- %s\n\n%s"%(origin, description, details))
|
|
else:
|
|
raise
|
|
|
|
class LocalService(object):
|
|
""" Proxy for local services.
|
|
|
|
Any instance of this class will behave like the single instance
|
|
of Service(name)
|
|
"""
|
|
def __init__(self, name):
|
|
self.__name = name
|
|
try:
|
|
self._service = Service._services[name]
|
|
for method_name, method_definition in self._service._methods.items():
|
|
setattr(self, method_name, method_definition)
|
|
except KeyError, keyError:
|
|
Logger().notifyChannel('module', LOG_ERROR, 'This service does not exist: %s' % (str(keyError),) )
|
|
raise
|
|
def __call__(self, method, *params):
|
|
return getattr(self, method)(*params)
|
|
|
|
class ExportService(object):
|
|
""" Proxy for exported services.
|
|
|
|
All methods here should take an AuthProxy as their first parameter. It
|
|
will be appended by the calling framework.
|
|
|
|
Note that this class has no direct proxy, capable of calling
|
|
eservice.method(). Rather, the proxy should call
|
|
dispatch(method,auth,params)
|
|
"""
|
|
|
|
_services = {}
|
|
_groups = {}
|
|
|
|
def __init__(self, name, audience=''):
|
|
ExportService._services[name] = self
|
|
self.__name = name
|
|
|
|
def joinGroup(self, name):
|
|
ExportService._groups.setdefault(name, {})[self.__name] = self
|
|
|
|
@classmethod
|
|
def getService(cls,name):
|
|
return cls._services[name]
|
|
|
|
def dispatch(self, method, auth, params):
|
|
raise Exception("stub dispatch at %s" % self.__name)
|
|
|
|
def new_dispatch(self,method,auth,params):
|
|
raise Exception("stub dispatch at %s" % self.__name)
|
|
|
|
def abortResponse(self, error, description, origin, details):
|
|
if not tools.config['debug_mode']:
|
|
raise Exception("%s -- %s\n\n%s"%(origin, description, details))
|
|
else:
|
|
raise
|
|
|
|
LOG_NOTSET = 'notset'
|
|
LOG_DEBUG_RPC = 'debug_rpc'
|
|
LOG_DEBUG = 'debug'
|
|
LOG_DEBUG2 = 'debug2'
|
|
LOG_INFO = 'info'
|
|
LOG_WARNING = 'warn'
|
|
LOG_ERROR = 'error'
|
|
LOG_CRITICAL = 'critical'
|
|
|
|
# add new log level below DEBUG
|
|
logging.DEBUG2 = logging.DEBUG - 1
|
|
logging.DEBUG_RPC = logging.DEBUG2 - 1
|
|
|
|
def init_logger():
|
|
import os
|
|
from tools.translate import resetlocale
|
|
resetlocale()
|
|
|
|
logger = logging.getLogger()
|
|
# create a format for log messages and dates
|
|
formatter = logging.Formatter('[%(asctime)s] %(levelname)s:%(name)s:%(message)s')
|
|
|
|
if tools.config['syslog']:
|
|
# SysLog Handler
|
|
if os.name == 'nt':
|
|
handler = logging.handlers.NTEventLogHandler("%s %s" %
|
|
(release.description,
|
|
release.version))
|
|
else:
|
|
handler = logging.handlers.SysLogHandler('/dev/log')
|
|
formatter = logging.Formatter("%s %s" % (release.description, release.version) + ':%(levelname)s:%(name)s:%(message)s')
|
|
|
|
elif tools.config['logfile']:
|
|
# LogFile Handler
|
|
logf = tools.config['logfile']
|
|
try:
|
|
dirname = os.path.dirname(logf)
|
|
if dirname and not os.path.isdir(dirname):
|
|
os.makedirs(dirname)
|
|
if tools.config['logrotate'] is not False:
|
|
handler = logging.handlers.TimedRotatingFileHandler(logf,'D',1,30)
|
|
elif os.name == 'posix':
|
|
handler = logging.handlers.WatchedFileHandler(logf)
|
|
else:
|
|
handler = logging.handlers.FileHandler(logf)
|
|
except Exception, ex:
|
|
sys.stderr.write("ERROR: couldn't create the logfile directory. Logging to the standard output.\n")
|
|
handler = logging.StreamHandler(sys.stdout)
|
|
else:
|
|
# Normal Handler on standard output
|
|
handler = logging.StreamHandler(sys.stdout)
|
|
|
|
|
|
# tell the handler to use this format
|
|
handler.setFormatter(formatter)
|
|
|
|
# add the handler to the root logger
|
|
logger.addHandler(handler)
|
|
logger.setLevel(int(tools.config['log_level'] or '0'))
|
|
|
|
if (not isinstance(handler, logging.FileHandler)) and os.name != 'nt':
|
|
# change color of level names
|
|
# uses of ANSI color codes
|
|
# see http://pueblo.sourceforge.net/doc/manual/ansi_color_codes.html
|
|
# maybe use http://code.activestate.com/recipes/574451/
|
|
colors = ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', None, 'default']
|
|
foreground = lambda f: 30 + colors.index(f)
|
|
background = lambda f: 40 + colors.index(f)
|
|
|
|
mapping = {
|
|
'DEBUG_RPC': ('blue', 'white'),
|
|
'DEBUG2': ('green', 'white'),
|
|
'DEBUG': ('blue', 'default'),
|
|
'INFO': ('green', 'default'),
|
|
'WARNING': ('yellow', 'default'),
|
|
'ERROR': ('red', 'default'),
|
|
'CRITICAL': ('white', 'red'),
|
|
}
|
|
|
|
for level, (fg, bg) in mapping.items():
|
|
msg = "\x1b[%dm\x1b[%dm%s\x1b[0m" % (foreground(fg), background(bg), level)
|
|
logging.addLevelName(getattr(logging, level), msg)
|
|
|
|
|
|
class Logger(object):
|
|
|
|
def notifyChannel(self, name, level, msg):
|
|
from service.web_services import common
|
|
|
|
log = logging.getLogger(tools.ustr(name))
|
|
|
|
if level == LOG_DEBUG2 and not hasattr(log, level):
|
|
fct = lambda msg, *args, **kwargs: log.log(logging.DEBUG2, msg, *args, **kwargs)
|
|
setattr(log, LOG_DEBUG2, fct)
|
|
|
|
if level == LOG_DEBUG_RPC and not hasattr(log, level):
|
|
fct = lambda msg, *args, **kwargs: log.log(logging.DEBUG_RPC, msg, *args, **kwargs)
|
|
setattr(log, LOG_DEBUG_RPC, fct)
|
|
|
|
level_method = getattr(log, level)
|
|
|
|
if isinstance(msg, Exception):
|
|
msg = tools.exception_to_unicode(msg)
|
|
|
|
try:
|
|
msg = tools.ustr(msg).strip()
|
|
if level in (LOG_ERROR,LOG_CRITICAL) and tools.config.get_misc('debug','env_info',False):
|
|
msg = common().exp_get_server_environment() + "\n" + msg
|
|
|
|
result = msg.split('\n')
|
|
except UnicodeDecodeError:
|
|
result = msg.strip().split('\n')
|
|
try:
|
|
if len(result)>1:
|
|
for idx, s in enumerate(result):
|
|
level_method('[%02d]: %s' % (idx+1, s,))
|
|
elif result:
|
|
level_method(result[0])
|
|
except IOError,e:
|
|
# TODO: perhaps reset the logger streams?
|
|
#if logrotate closes our files, we end up here..
|
|
pass
|
|
except:
|
|
# better ignore the exception and carry on..
|
|
pass
|
|
|
|
def set_loglevel(self, level):
|
|
log = logging.getLogger()
|
|
log.setLevel(logging.INFO) # make sure next msg is printed
|
|
log.info("Log level changed to %s" % logging.getLevelName(level))
|
|
log.setLevel(level)
|
|
|
|
def shutdown(self):
|
|
logging.shutdown()
|
|
|
|
import tools
|
|
init_logger()
|
|
|
|
class Agent(object):
|
|
_timers = {}
|
|
_logger = Logger()
|
|
|
|
def setAlarm(self, fn, dt, db_name, *args, **kwargs):
|
|
wait = dt - time.time()
|
|
if wait > 0:
|
|
self._logger.notifyChannel('timers', LOG_DEBUG, "Job scheduled in %.3g seconds for %s.%s" % (wait, fn.im_class.__name__, fn.func_name))
|
|
timer = threading.Timer(wait, fn, args, kwargs)
|
|
timer.start()
|
|
self._timers.setdefault(db_name, []).append(timer)
|
|
|
|
for db in self._timers:
|
|
for timer in self._timers[db]:
|
|
if not timer.isAlive():
|
|
self._timers[db].remove(timer)
|
|
|
|
@classmethod
|
|
def cancel(cls, db_name):
|
|
"""Cancel all timers for a given database. If None passed, all timers are cancelled"""
|
|
for db in cls._timers:
|
|
if db_name is None or db == db_name:
|
|
for timer in cls._timers[db]:
|
|
timer.cancel()
|
|
|
|
@classmethod
|
|
def quit(cls):
|
|
cls.cancel(None)
|
|
|
|
import traceback
|
|
|
|
class Server:
|
|
""" Generic interface for all servers with an event loop etc.
|
|
Override this to impement http, net-rpc etc. servers.
|
|
|
|
Servers here must have threaded behaviour. start() must not block,
|
|
there is no run().
|
|
"""
|
|
__is_started = False
|
|
__servers = []
|
|
|
|
def __init__(self):
|
|
if Server.__is_started:
|
|
raise Exception('All instances of servers must be inited before the startAll()')
|
|
Server.__servers.append(self)
|
|
|
|
def start(self):
|
|
print "called stub Server.start"
|
|
pass
|
|
|
|
def stop(self):
|
|
print "called stub Server.stop"
|
|
pass
|
|
|
|
def stats(self):
|
|
""" This function should return statistics about the server """
|
|
return "%s: No statistics" % str(self.__class__)
|
|
|
|
@classmethod
|
|
def startAll(cls):
|
|
if cls.__is_started:
|
|
return
|
|
Logger().notifyChannel("services", LOG_INFO,
|
|
"Starting %d services" % len(cls.__servers))
|
|
for srv in cls.__servers:
|
|
srv.start()
|
|
cls.__is_started = True
|
|
|
|
@classmethod
|
|
def quitAll(cls):
|
|
if not cls.__is_started:
|
|
return
|
|
Logger().notifyChannel("services", LOG_INFO,
|
|
"Stopping %d services" % len(cls.__servers))
|
|
for srv in cls.__servers:
|
|
srv.stop()
|
|
cls.__is_started = False
|
|
|
|
@classmethod
|
|
def allStats(cls):
|
|
res = ''
|
|
if cls.__is_started:
|
|
res += "Servers started\n"
|
|
else:
|
|
res += "Servers stopped\n"
|
|
for srv in cls.__servers:
|
|
try:
|
|
res += srv.stats() + "\n"
|
|
except:
|
|
pass
|
|
return res
|
|
|
|
class OpenERPDispatcherException(Exception):
|
|
def __init__(self, exception, traceback):
|
|
self.exception = exception
|
|
self.traceback = traceback
|
|
|
|
class OpenERPDispatcher:
|
|
def log(self, title, msg):
|
|
from pprint import pformat
|
|
Logger().notifyChannel('%s' % title, LOG_DEBUG_RPC, pformat(msg))
|
|
|
|
def dispatch(self, service_name, method, params):
|
|
try:
|
|
self.log('service', service_name)
|
|
self.log('method', method)
|
|
self.log('params', params)
|
|
if hasattr(self,'auth_provider'):
|
|
auth = self.auth_provider
|
|
else:
|
|
auth = None
|
|
result = ExportService.getService(service_name).dispatch(method, auth, params)
|
|
self.log('result', result)
|
|
# We shouldn't marshall None,
|
|
if result == None:
|
|
result = False
|
|
return result
|
|
except Exception, e:
|
|
self.log('exception', tools.exception_to_unicode(e))
|
|
if hasattr(e, 'traceback'):
|
|
tb = e.traceback
|
|
else:
|
|
tb = sys.exc_info()
|
|
tb_s = "".join(traceback.format_exception(*tb))
|
|
if tools.config['debug_mode']:
|
|
import pdb
|
|
pdb.post_mortem(tb[2])
|
|
raise OpenERPDispatcherException(e, tb_s)
|
|
|
|
class GenericXMLRPCRequestHandler(OpenERPDispatcher):
|
|
def _dispatch(self, method, params):
|
|
try:
|
|
service_name = self.path.split("/")[-1]
|
|
return self.dispatch(service_name, method, params)
|
|
except OpenERPDispatcherException, e:
|
|
raise xmlrpclib.Fault(tools.exception_to_unicode(e.exception), e.traceback)
|
|
|
|
class SSLSocket(object):
|
|
def __init__(self, socket):
|
|
if not hasattr(socket, 'sock_shutdown'):
|
|
from OpenSSL import SSL
|
|
ctx = SSL.Context(SSL.SSLv23_METHOD)
|
|
ctx.use_privatekey_file(tools.config['secure_pkey_file'])
|
|
ctx.use_certificate_file(tools.config['secure_cert_file'])
|
|
self.socket = SSL.Connection(ctx, socket)
|
|
else:
|
|
self.socket = socket
|
|
|
|
def shutdown(self, how):
|
|
return self.socket.sock_shutdown(how)
|
|
|
|
def __getattr__(self, name):
|
|
return getattr(self.socket, name)
|
|
|
|
class SimpleXMLRPCRequestHandler(GenericXMLRPCRequestHandler, SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):
|
|
rpc_paths = map(lambda s: '/xmlrpc/%s' % s, GROUPS.get('web-services', {}).keys())
|
|
|
|
class SecureXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
|
|
def setup(self):
|
|
self.connection = SSLSocket(self.request)
|
|
self.rfile = socket._fileobject(self.request, "rb", self.rbufsize)
|
|
self.wfile = socket._fileobject(self.request, "wb", self.wbufsize)
|
|
|
|
class SimpleThreadedXMLRPCServer(SocketServer.ThreadingMixIn, SimpleXMLRPCServer.SimpleXMLRPCServer):
|
|
def server_bind(self):
|
|
self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
SimpleXMLRPCServer.SimpleXMLRPCServer.server_bind(self)
|
|
|
|
class SecureThreadedXMLRPCServer(SimpleThreadedXMLRPCServer):
|
|
def __init__(self, server_address, HandlerClass, logRequests=1):
|
|
SimpleThreadedXMLRPCServer.__init__(self, server_address, HandlerClass, logRequests)
|
|
self.socket = SSLSocket(socket.socket(self.address_family, self.socket_type))
|
|
self.server_bind()
|
|
self.server_activate()
|
|
|
|
class HttpDaemon(threading.Thread):
|
|
def __init__(self, interface, port, secure=False):
|
|
threading.Thread.__init__(self)
|
|
self.__port = port
|
|
self.__interface = interface
|
|
self.secure = bool(secure)
|
|
handler_class = (SimpleXMLRPCRequestHandler, SecureXMLRPCRequestHandler)[self.secure]
|
|
server_class = (SimpleThreadedXMLRPCServer, SecureThreadedXMLRPCServer)[self.secure]
|
|
|
|
if self.secure:
|
|
from OpenSSL.SSL import Error as SSLError
|
|
else:
|
|
class SSLError(Exception): pass
|
|
try:
|
|
self.server = server_class((interface, port), handler_class, 0)
|
|
except SSLError, e:
|
|
Logger().notifyChannel('xml-rpc-ssl', LOG_CRITICAL, "Can not load the certificate and/or the private key files")
|
|
sys.exit(1)
|
|
except Exception, e:
|
|
Logger().notifyChannel('xml-rpc', LOG_CRITICAL, "Error occur when starting the server daemon: %s" % (e,))
|
|
sys.exit(1)
|
|
|
|
|
|
def attach(self, path, gw):
|
|
pass
|
|
|
|
def stop(self):
|
|
self.running = False
|
|
if os.name != 'nt':
|
|
try:
|
|
self.server.socket.shutdown(
|
|
hasattr(socket, 'SHUT_RDWR') and socket.SHUT_RDWR or 2)
|
|
except socket.error, e:
|
|
if e.errno != 57: raise
|
|
# OSX, socket shutdowns both sides if any side closes it
|
|
# causing an error 57 'Socket is not connected' on shutdown
|
|
# of the other side (or something), see
|
|
# http://bugs.python.org/issue4397
|
|
Logger().notifyChannel(
|
|
'server', LOG_DEBUG,
|
|
'"%s" when shutting down server socket, '
|
|
'this is normal under OS X'%e)
|
|
self.server.socket.close()
|
|
|
|
def run(self):
|
|
self.server.register_introspection_functions()
|
|
|
|
self.running = True
|
|
while self.running:
|
|
self.server.handle_request()
|
|
return True
|
|
|
|
# If the server need to be run recursively
|
|
#
|
|
#signal.signal(signal.SIGALRM, self.my_handler)
|
|
#signal.alarm(6)
|
|
#while True:
|
|
# self.server.handle_request()
|
|
#signal.alarm(0) # Disable the alarm
|
|
|
|
import tiny_socket
|
|
class TinySocketClientThread(threading.Thread, OpenERPDispatcher):
|
|
def __init__(self, sock, threads):
|
|
threading.Thread.__init__(self)
|
|
self.sock = sock
|
|
self.threads = threads
|
|
|
|
def run(self):
|
|
import select
|
|
self.running = True
|
|
try:
|
|
ts = tiny_socket.mysocket(self.sock)
|
|
except:
|
|
self.sock.close()
|
|
self.threads.remove(self)
|
|
return False
|
|
while self.running:
|
|
try:
|
|
msg = ts.myreceive()
|
|
except:
|
|
self.sock.close()
|
|
self.threads.remove(self)
|
|
return False
|
|
try:
|
|
result = self.dispatch(msg[0], msg[1], msg[2:])
|
|
ts.mysend(result)
|
|
except OpenERPDispatcherException, e:
|
|
new_e = Exception(tools.exception_to_unicode(e.exception)) # avoid problems of pickeling
|
|
ts.mysend(new_e, exception=True, traceback=e.traceback)
|
|
|
|
self.sock.close()
|
|
self.threads.remove(self)
|
|
return True
|
|
|
|
def stop(self):
|
|
self.running = False
|
|
|
|
|
|
class TinySocketServerThread(threading.Thread):
|
|
def __init__(self, interface, port, secure=False):
|
|
threading.Thread.__init__(self)
|
|
self.__port = port
|
|
self.__interface = interface
|
|
self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
self.socket.bind((self.__interface, self.__port))
|
|
self.socket.listen(5)
|
|
self.threads = []
|
|
|
|
def run(self):
|
|
import select
|
|
try:
|
|
self.running = True
|
|
while self.running:
|
|
(clientsocket, address) = self.socket.accept()
|
|
ct = TinySocketClientThread(clientsocket, self.threads)
|
|
self.threads.append(ct)
|
|
ct.start()
|
|
self.socket.close()
|
|
except Exception, e:
|
|
self.socket.close()
|
|
return False
|
|
|
|
def stop(self):
|
|
self.running = False
|
|
for t in self.threads:
|
|
t.stop()
|
|
try:
|
|
if hasattr(socket, 'SHUT_RDWR'):
|
|
self.socket.shutdown(socket.SHUT_RDWR)
|
|
else:
|
|
self.socket.shutdown(2)
|
|
self.socket.close()
|
|
except:
|
|
return False
|
|
|
|
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
|