connectors/PYRO/__init__.py
author etisserant
Wed, 03 Sep 2008 17:28:17 +0200
changeset 235 a66e150f2888
parent 231 f1db3ce8f40a
child 284 3fecc96090c8
permissions -rwxr-xr-x
Improved debug data feedback.
203
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     1
#!/usr/bin/env python
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     2
# -*- coding: utf-8 -*-
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     3
#
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     4
#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     5
#
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     6
#See COPYING file for copyrights details.
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     7
#
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     8
#This library is free software; you can redistribute it and/or
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
     9
#modify it under the terms of the GNU General Public
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    10
#License as published by the Free Software Foundation; either
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    11
#version 2.1 of the License, or (at your option) any later version.
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    12
#
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    13
#This library is distributed in the hope that it will be useful,
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    14
#but WITHOUT ANY WARRANTY; without even the implied warranty of
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    15
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    16
#General Public License for more details.
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    17
#
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    18
#You should have received a copy of the GNU General Public
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    19
#License along with this library; if not, write to the Free Software
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    20
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    21
import Pyro.core as pyro
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    22
from Pyro.errors import PyroError
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    23
import traceback
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    24
from time import sleep
231
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    25
import copy
203
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    26
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    27
def PYRO_connector_factory(uri, pluginsroot):
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    28
    """
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    29
    This returns the connector to Pyro style PLCobject
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    30
    """
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    31
    pluginsroot.logger.write("Connecting to URI : %s\n"%uri)
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    32
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    33
    servicetype, location = uri.split("://")
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    34
    
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    35
    # Try to get the proxy object
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    36
    try :
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    37
        RemotePLCObjectProxy = pyro.getAttrProxyForURI("PYROLOC://"+location+"/PLCObject")
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    38
    except Exception, msg:
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    39
        pluginsroot.logger.write_error("Wrong URI, please check it !\n")
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    40
        pluginsroot.logger.write_error(traceback.format_exc())
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    41
        return None
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    42
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    43
    def PyroCatcher(func, default=None):
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    44
        """
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    45
        A function that catch a pyro exceptions, write error to logger
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    46
        and return defaul value when it happen
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    47
        """
218
71fddab24be9 remove old code and fix typo
greg
parents: 203
diff changeset
    48
        def catcher_func(*args,**kwargs):
203
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    49
            try:
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    50
                return func(*args,**kwargs)
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    51
            except PyroError,e:
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    52
                #pluginsroot.logger.write_error(traceback.format_exc())
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    53
                pluginsroot.logger.write_error(str(e))
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    54
                pluginsroot._Disconnect()
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    55
                return default
218
71fddab24be9 remove old code and fix typo
greg
parents: 203
diff changeset
    56
        return catcher_func
203
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    57
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    58
    # Check connection is effective. 
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    59
    # lambda is for getattr of GetPLCstatus to happen inside catcher
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    60
    if PyroCatcher(lambda:RemotePLCObjectProxy.GetPLCstatus())() == None:
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    61
        pluginsroot.logger.write_error("Cannot get PLC status - connection failed.\n")
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    62
        return None
231
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    63
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    64
    # for safe use in from debug thread, must create a copy
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    65
    RemotePLCObjectProxyCopy = copy.copy(RemotePLCObjectProxy)
203
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    66
        
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    67
    class PyroProxyProxy:
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    68
        """
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    69
        A proxy proxy class to handle Beremiz Pyro interface specific behavior.
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    70
        And to put pyro exception catcher in between caller and pyro proxy
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    71
        """
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    72
        def GetPyroProxy(self):
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    73
            """
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    74
            This func returns the real Pyro Proxy.
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    75
            Use this if you musn't keep reference to it.
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    76
            """
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
    77
            return RemotePLCObjectProxy
231
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    78
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 231
diff changeset
    79
        def _PyroStartPLC(self, *args, **kwargs):
231
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    80
            """
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    81
            pluginsroot._connector.GetPyroProxy() is used 
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    82
            rather than RemotePLCObjectProxy because
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    83
            object is recreated meanwhile, 
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    84
            so we must not keep ref to it here
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    85
            """
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    86
            if pluginsroot._connector.GetPyroProxy().GetPLCstatus() == "Dirty":
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    87
                """
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    88
                Some bad libs with static symbols may polute PLC
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    89
                ask runtime to suicide and come back again
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    90
                """
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    91
                pluginsroot.logger.write("Force runtime reload\n")
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    92
                pluginsroot._connector.GetPyroProxy().ForceReload()
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    93
                pluginsroot._Disconnect()
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    94
                # let remote PLC time to resurect.(freeze app)
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    95
                sleep(0.5)
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    96
                pluginsroot._Connect()
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 231
diff changeset
    97
            return pluginsroot._connector.GetPyroProxy().StartPLC(*args, **kwargs)
231
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    98
        StartPLC = PyroCatcher(_PyroStartPLC, False)
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
    99
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   100
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   101
        def _PyroGetTraceVariables(self):
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   102
            """
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   103
            for safe use in from debug thread, must use the copy
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   104
            """
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 231
diff changeset
   105
            if RemotePLCObjectProxyCopy.GetPLCstatus() == "Started":
a66e150f2888 Improved debug data feedback.
etisserant
parents: 231
diff changeset
   106
                return RemotePLCObjectProxyCopy.GetTraceVariables()
a66e150f2888 Improved debug data feedback.
etisserant
parents: 231
diff changeset
   107
            else:
a66e150f2888 Improved debug data feedback.
etisserant
parents: 231
diff changeset
   108
                return None,None
231
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   109
        GetTraceVariables = PyroCatcher(_PyroGetTraceVariables)
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   110
203
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   111
        
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   112
        def __getattr__(self, attrName):
231
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   113
            member = self.__dict__.get(attrName, None)
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   114
            if member is None:
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   115
                def my_local_func(*args,**kwargs):
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   116
                    return RemotePLCObjectProxy.__getattr__(attrName)(*args,**kwargs)
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   117
                member = PyroCatcher(my_local_func, None)
203
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   118
                self.__dict__[attrName] = member
231
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   119
            return member
f1db3ce8f40a Re-organized pyro connector proxy members mascarading
etisserant
parents: 218
diff changeset
   120
203
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   121
    return PyroProxyProxy()
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   122
    
cb9901076a21 Added concepts :
etisserant
parents:
diff changeset
   123