Source code for

# -*- coding: utf-8 -*-
# vi:si:et:sw=4:sts=4:ts=4

## Copyright (C) 2016 Async Open Source
## This program is free software; you can redistribute it and/or
## modify it under the terms of the GNU Lesser General Public License
## as published by the Free Software Foundation; either version 2
## 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
## GNU Lesser General Public License for more details.
## You should have received a copy of the GNU Lesser General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., or visit:
## Author(s): Stoq Team <>

"""Stoq server utilities"""

import socket
import xmlrpclib

from stoqlib.api import api
from stoqlib.database.settings import db_settings
from stoqlib.lib.configparser import get_config
from stoqlib.lib.translation import stoqlib_gettext as _

[docs]class ServerError(Exception): """Base error for :class:`.ServerProxy` connection issues""" def __init__(self, message, code=None): super(ServerError, self).__init__(message) self.fault_code = code def __str__(self): message = super(ServerError, self).__str__() if self.fault_code is not None: message = "%s: %s" % (self.fault_code, message) return message
[docs]class ServerProxy(object): """Proxy to communicate with a Stoq Server instance""" DEFAULT_TIMEOUT = 30 def __init__(self, timeout=DEFAULT_TIMEOUT): self._timeout = timeout self._proxy = None # # Public API #
[docs] def call(self, method, *args): """Call a remote method on stoq server. :param method: the method to call :param args: extra args to pass to add to the call :return: the response :raises: :exc:`ServerError` in case of errors """ try: proxy = self._get_proxy() return getattr(proxy, method)(*args) except xmlrpclib.Fault as e: raise ServerError(e.faultString, e.faultCode) except socket.error as e: raise ServerError(str(e))
[docs] def check_running(self): """Call a remote method on stoq server. :param method: the method to call :param args: extra args to pass to add to the call :return: the response :raises: :exc:`ServerError` in case of errors """ try: proxy = self._get_proxy() except Exception: proxy = None return proxy is not None
# # Private # def _get_proxy(self): if self._proxy is None: config = get_config() address = config.get('General', 'serveraddress') if not address: with api.new_store() as store: query = ("SELECT client_addr FROM pg_stat_activity " "WHERE application_name LIKE ? AND " " datname = ? " "LIMIT 1") params = [u'stoqserver%', unicode(db_settings.dbname)] res = store.execute(query, params=params).get_one() if res: # When stoqserver is located in another machine if res[0] not in ['', '::1', '', None]: address = res[0] else: # XXX: For now we only support ipv4 # XXX: If the client_addr is NULL, then stoqserver is # connected using the unix socket, which means that he # is in the same ip as the postgresql address = db_settings.address if not address: address = 'localhost' else: address = None if not address: raise ServerError(_("Stoq server not found")) port = config.get('General', 'serverport') or 6970 url = 'http://%s:%s/XMLRPC' % (address, port) default_timeout = socket.getdefaulttimeout() socket.setdefaulttimeout(self._timeout) self._proxy = xmlrpclib.ServerProxy(url, allow_none=True) socket.setdefaulttimeout(default_timeout) try: retval = except (Exception, AttributeError): self._proxy = None raise if not retval: raise ServerError(_("Server not responding to pings")) return self._proxy
if __name__ == '__main__': api.prepare_test() proxy = ServerProxy() try: retval ='ping') except ServerError as e: print "error: %s" % (e, ) else: print retval