1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

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

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

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

    17

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

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

from __future__ import absolute_import

    27

from __future__ import print_function

    28

import traceback

    29

from time import sleep

    30

import copy

    31

import socket

    32

import os.path

    33

    34

import Pyro

    35

import Pyro.core

    36

import Pyro.util

    37

from Pyro.errors import PyroError

    38

    39

from runtime import PlcStatus

    40

    41

service_type = '_PYRO._tcp.local.'

    42

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

    43

# supported by this connector confnode.

    44

#

    45

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

    46

# or set to an empty list.

    47

    48

    49

def PYRO_connector_factory(uri, confnodesroot):

    50

    """

    51

    This returns the connector to Pyro style PLCobject

    52

    """

    53

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

    54

    55

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

    56

    if servicetype == "PYROS":

    57

        schemename = "PYROLOCSSL"

    58

        # Protect against name->IP substitution in Pyro3

    59

        Pyro.config.PYRO_DNS_URI = True

    60

        # Beware Pyro lib need str path, not unicode

    61

        # don't rely on PYRO_STORAGE ! see documentation

    62

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

    63

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

    64

            confnodesroot.logger.write_error(

    65

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

    66

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

    67

            return None

    68

        else:

    69

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

    70

                                       % (Pyro.config.PYROSSL_CERTDIR))

    71

        Pyro.config.PYROSSL_CERT = "client.crt"

    72

        Pyro.config.PYROSSL_KEY = "client.key"

    73

    74

        # Ugly Monkey Patching

    75

        def _gettimeout(self):

    76

            return self.timeout

    77

    78

        def _settimeout(self, timeout):

    79

            self.timeout = timeout

    80

        from M2Crypto.SSL import Connection  # pylint: disable=import-error

    81

        Connection.timeout = None

    82

        Connection.gettimeout = _gettimeout

    83

        Connection.settimeout = _settimeout

    84

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

    85

        # match host, expected 127.0.0.1, got server

    86

        Connection.clientPostConnectionCheck = None

    87

    else:

    88

        schemename = "PYROLOC"

    89

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

    90

        try:

    91

            from zeroconf import Zeroconf

    92

            r = Zeroconf()

    93

            i = r.get_service_info(service_type, location)

    94

            if i is None:

    95

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

    96

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

    97

            port = str(i.port)

    98

            newlocation = ip + ':' + port

    99

            confnodesroot.logger.write(_("'{a1}' is located at {a2}\n").format(a1=location, a2=newlocation))

   100

            location = newlocation

   101

            r.close()

   102

        except Exception:

   103

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

   104

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

   105

            return None

   106

   107

    # Try to get the proxy object

   108

    try:

   109

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

   110

    except Exception:

   111

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

   112

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

   113

        return None

   114

   115

    def PyroCatcher(func, default=None):

   116

        """

   117

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

   118

        and return default value when it happen

   119

        """

   120

        def catcher_func(*args, **kwargs):

   121

            try:

   122

                return func(*args, **kwargs)

   123

            except Pyro.errors.ConnectionClosedError as e:

   124

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

   125

                confnodesroot._SetConnector(None)

   126

            except Pyro.errors.ProtocolError as e:

   127

                confnodesroot.logger.write_error(_("Pyro exception: %s\n") % e)

   128

            except Exception as e:

   129

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

   130

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

   131

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

   132

                print(errmess)

   133

                confnodesroot._SetConnector(None)

   134

            return default

   135

        return catcher_func

   136

   137

    # Check connection is effective.

   138

    # lambda is for getattr of GetPLCstatus to happen inside catcher

   139

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

   140

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

   141

        return None

   142

   143

    _special_return_funcs = {

   144

        "StartPLC": False,

   145

        "GetTraceVariables": ("Broken", None),

   146

        "GetPLCstatus": (PlcStatus.Broken, None),

   147

        "RemoteExec": (-1, "RemoteExec script failed!")

   148

    }

   149

   150

    class PyroProxyProxy(object):

   151

        """

   152

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

   153

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

   154

        """

   155

        def __getattr__(self, attrName):

   156

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

   157

            if member is None:

   158

                def my_local_func(*args, **kwargs):

   159

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

   160

                member = PyroCatcher(my_local_func, _special_return_funcs.get(attrName, None))

   161

                self.__dict__[attrName] = member

   162

            return member

   163

   164

    return PyroProxyProxy()