1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

#

     4

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     5

#

     6

# See COPYING file for copyrights details.

     7

#

     8

# This library is free software; you can redistribute it and/or

     9

# modify it under the terms of the GNU General Public

    10

# License as published by the Free Software Foundation; either

    11

# version 2.1 of the License, or (at your option) any later version.

    12

#

    13

# This library is distributed in the hope that it will be useful,

    14

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    16

# General Public License for more details.

    17

#

    18

# You should have received a copy of the GNU General Public

    19

# License along with this library; if not, write to the Free Software

    20

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    21

import Pyro

    22

import Pyro.core

    23

import Pyro.util

    24

from Pyro.errors import PyroError

    25

import traceback

    26

from time import sleep

    27

import copy

    28

import socket

    29

service_type = '_PYRO._tcp.local.'

    30

import os.path

    31

# this module attribute contains a list of DNS-SD (Zeroconf) service types

    32

# supported by this connector confnode.

    33

#

    34

# for connectors that do not support DNS-SD, this attribute can be omitted

    35

# or set to an empty list.

    36

    37

def PYRO_connector_factory(uri, confnodesroot):

    38

    """

    39

    This returns the connector to Pyro style PLCobject

    40

    """

    41

    confnodesroot.logger.write(_("PYRO connecting to URI : %s\n") % uri)

    42

    43

    servicetype, location = uri.split("://")

    44

    if servicetype == "PYROS":

    45

        schemename = "PYROLOCSSL"

    46

        # Protect against name->IP substitution in Pyro3

    47

        Pyro.config.PYRO_DNS_URI = True

    48

        # Beware Pyro lib need str path, not unicode

    49

        # don't rely on PYRO_STORAGE ! see documentation

    50

        Pyro.config.PYROSSL_CERTDIR = os.path.abspath(str(confnodesroot.ProjectPath) + '/certs')

    51

        if not os.path.exists(Pyro.config.PYROSSL_CERTDIR):

    52

            confnodesroot.logger.write_error(

    53

                'Error : the directory %s is missing for SSL certificates (certs_dir).'

    54

                'Please fix it in your project.\n' % Pyro.config.PYROSSL_CERTDIR)

    55

            return None

    56

        else:

    57

            confnodesroot.logger.write(_("PYRO using certificates in '%s' \n")

    58

                                       % (Pyro.config.PYROSSL_CERTDIR))

    59

        Pyro.config.PYROSSL_CERT = "client.crt"

    60

        Pyro.config.PYROSSL_KEY = "client.key"

    61

        # Ugly Monkey Patching

    62

        def _gettimeout(self):

    63

            return self.timeout

    64

    65

        def _settimeout(self, timeout):

    66

            self.timeout = timeout

    67

        from M2Crypto.SSL import Connection

    68

        Connection.timeout = None

    69

        Connection.gettimeout = _gettimeout

    70

        Connection.settimeout = _settimeout

    71

        # M2Crypto.SSL.Checker.WrongHost: Peer certificate commonName does not

    72

        # match host, expected 127.0.0.1, got server

    73

        Connection.clientPostConnectionCheck = None

    74

    else:

    75

        schemename = "PYROLOC"

    76

    if location.find(service_type) != -1:

    77

        try:

    78

            from util.Zeroconf import Zeroconf

    79

            r = Zeroconf()

    80

            i = r.getServiceInfo(service_type, location)

    81

            if i is None:

    82

                raise Exception("'%s' not found" % location)

    83

            ip = str(socket.inet_ntoa(i.getAddress()))

    84

            port = str(i.getPort())

    85

            newlocation = ip + ':' + port

    86

            confnodesroot.logger.write(_("'%s' is located at %s\n") % (location, newlocation))

    87

            location = newlocation

    88

            r.close()

    89

        except Exception, msg:

    90

            confnodesroot.logger.write_error(_("MDNS resolution failure for '%s'\n") % location)

    91

            confnodesroot.logger.write_error(traceback.format_exc())

    92

            return None

    93

    94

    # Try to get the proxy object

    95

    try:

    96

        RemotePLCObjectProxy = Pyro.core.getAttrProxyForURI(schemename + "://" + location + "/PLCObject")

    97

    except Exception, msg:

    98

        confnodesroot.logger.write_error(_("Connection to '%s' failed.\n") % location)

    99

        confnodesroot.logger.write_error(traceback.format_exc())

   100

        return None

   101

   102

    def PyroCatcher(func, default=None):

   103

        """

   104

        A function that catch a Pyro exceptions, write error to logger

   105

        and return default value when it happen

   106

        """

   107

        def catcher_func(*args, **kwargs):

   108

            try:

   109

                return func(*args, **kwargs)

   110

            except Pyro.errors.ConnectionClosedError, e:

   111

                confnodesroot.logger.write_error("Connection lost!\n")

   112

                confnodesroot._SetConnector(None)

   113

            except Pyro.errors.ProtocolError, e:

   114

                confnodesroot.logger.write_error("Pyro exception: " + str(e) + "\n")

   115

            except Exception, e:

   116

                # confnodesroot.logger.write_error(traceback.format_exc())

   117

                errmess = ''.join(Pyro.util.getPyroTraceback(e))

   118

                confnodesroot.logger.write_error(errmess + "\n")

   119

                print errmess

   120

                confnodesroot._SetConnector(None)

   121

            return default

   122

        return catcher_func

   123

   124

    # Check connection is effective.

   125

    # lambda is for getattr of GetPLCstatus to happen inside catcher

   126

    if PyroCatcher(lambda: RemotePLCObjectProxy.GetPLCstatus())() is None:

   127

        confnodesroot.logger.write_error(_("Cannot get PLC status - connection failed.\n"))

   128

        return None

   129

   130

    class PyroProxyProxy(object):

   131

        """

   132

        A proxy proxy class to handle Beremiz Pyro interface specific behavior.

   133

        And to put Pyro exception catcher in between caller and Pyro proxy

   134

        """

   135

        def __init__(self):

   136

            # for safe use in from debug thread, must create a copy

   137

            self.RemotePLCObjectProxyCopy = None

   138

   139

        def GetPyroProxy(self):

   140

            """

   141

            This func returns the real Pyro Proxy.

   142

            Use this if you musn't keep reference to it.

   143

            """

   144

            return RemotePLCObjectProxy

   145

   146

        def _PyroStartPLC(self, *args, **kwargs):

   147

            """

   148

            confnodesroot._connector.GetPyroProxy() is used

   149

            rather than RemotePLCObjectProxy because

   150

            object is recreated meanwhile,

   151

            so we must not keep ref to it here

   152

            """

   153

            current_status, log_count = confnodesroot._connector.GetPyroProxy().GetPLCstatus()

   154

            if current_status == "Dirty":

   155

                """

   156

                Some bad libs with static symbols may polute PLC

   157

                ask runtime to suicide and come back again

   158

                """

   159

                confnodesroot.logger.write(_("Force runtime reload\n"))

   160

                confnodesroot._connector.GetPyroProxy().ForceReload()

   161

                confnodesroot._Disconnect()

   162

                # let remote PLC time to resurect.(freeze app)

   163

                sleep(0.5)

   164

                confnodesroot._Connect()

   165

            self.RemotePLCObjectProxyCopy = copy.copy(confnodesroot._connector.GetPyroProxy())

   166

            return confnodesroot._connector.GetPyroProxy().StartPLC(*args, **kwargs)

   167

        StartPLC = PyroCatcher(_PyroStartPLC, False)

   168

   169

        def _PyroGetTraceVariables(self):

   170

            """

   171

            for safe use in from debug thread, must use the copy

   172

            """

   173

            if self.RemotePLCObjectProxyCopy is None:

   174

                self.RemotePLCObjectProxyCopy = copy.copy(confnodesroot._connector.GetPyroProxy())

   175

            return self.RemotePLCObjectProxyCopy.GetTraceVariables()

   176

        GetTraceVariables = PyroCatcher(_PyroGetTraceVariables, ("Broken", None))

   177

   178

        def _PyroGetPLCstatus(self):

   179

            return RemotePLCObjectProxy.GetPLCstatus()

   180

        GetPLCstatus = PyroCatcher(_PyroGetPLCstatus, ("Broken", None))

   181

   182

        def _PyroRemoteExec(self, script, **kwargs):

   183

            return RemotePLCObjectProxy.RemoteExec(script, **kwargs)

   184

        RemoteExec = PyroCatcher(_PyroRemoteExec, (-1, "RemoteExec script failed!"))

   185

   186

        def __getattr__(self, attrName):

   187

            member = self.__dict__.get(attrName, None)

   188

            if member is None:

   189

                def my_local_func(*args, **kwargs):

   190

                    return RemotePLCObjectProxy.__getattr__(attrName)(*args, **kwargs)

   191

                member = PyroCatcher(my_local_func, None)

   192

                self.__dict__[attrName] = member

   193

            return member

   194

   195

    return PyroProxyProxy()