mplServer2.py 10.5 KB
Newer Older
1
2
3
import SocketServer
import pickle

Yori Fournier's avatar
Yori Fournier committed
4
from . import Signal,Status,Query,Answer
5
6
7
8

from . import SERVER_IOFUNCTIONS
from . import SERVER_FIGURES

9
10
from . import MyFig

11
from . import DBUG,WARN,SPCE,SEVR,INFO
Yori Fournier's avatar
Yori Fournier committed
12
from . import MplUnpickler
13
14

G_RAWDATA = dict()
15
G_FIGURES = dict()
16
17

DEBUG = True
18
debug = True
19
class MplHandler(SocketServer.StreamRequestHandler):
20
    
21
    def servPrint(self,x) : # This should be replaced with a proper implementation (s.b.) ?
22
        print("SERVER: "+x)
23
24
25
26
27
28

    def dprint(*args): #likewise for WARN,SPCE,SEVR,INFO :wprint,sprint,sevprint,iprint ?
        argsl = list(args)
        if type(argsl[0]) is str :
            argsl[0] = DBUG + argsl[0]
        print(''.join([repr(arg) for arg in argsl]))
29
30
31
32
33
34
35
36
37
38
    
    def treatReadData(self,content):
        '''Treat signals of type readData.
        1. unpack signal with instruction size, 
        2. send receipt, 
        3. unpack instructions, 
        4. execute instructions,
        5. send dataID.
        '''
        
Yori Fournier's avatar
Yori Fournier committed
39
40
#        fct      = SERVER_IOFUNCTIONS[content.get('func')]
        fct      = self.server.knownFunctions[content.get('func')]
41
42
43
44
45
46
47
48
49
50
51
52
53
54
        args     = content.get('args')
        kwargs   = content.get('kwargs')
        dataName = content.get('dataname')
        
         # Try to execute the instructions
        try:
            G_RAWDATA[dataName] = fct(*args, **kwargs)
            if (DEBUG):
                print(INFO+"SERVER: I read the data following instructions")
#                print(str(G_RAWDATA[dataName].data))  # SHOULD BE SUPPRESS LATER
        except:
            if(DEBUG):
                print(WARN+"SERVER: The instructions of readData could not be executed.")
                print(SPCE+"SERVER: I tried: "+str(fct.__name__)+'('+str(args)+', '+str(kwargs)+')')
55
            return Status(False,"The instructions of readData could not be executed. I tried: "+str(fct.__name__)+'('+str(args)+', '+str(kwargs)+')')
56
        if dataName in G_RAWDATA :
57
58
59
60
61
62
63
            return Status(True,"SERVER: I read the data following instructions"+str(fct.__name__)+'('+str(args)+', '+str(kwargs)+')')
         
        return False #should never get here
        
    def treatNewSyncFigure(self,content) :
        # Try to create the requested figure
        
Yori Fournier's avatar
Yori Fournier committed
64
        FigClass = self.server.knownFigures[content.get('figClassName')]
65
66
        args     = content.get('args')
        kwargs   = content.get('kwargs')
67
68
69
        datanames = content.get('dataName')
        
        datas     = [G_RAWDATA[name] for name in datanames]
70
71
        
        try:
72
73
            # create the figure:
            fig = FigClass(datas, **kwargs)
74
75
            if (DEBUG):
                print(INFO+"SERVER: I created the requested Figure")
76
        except Exception as e:
77
78
79
            if (DEBUG):
                print(WARN+"SERVER: I could not create the requested Figure.")
                print(SPCE+"SERVER: I tried: "+str(FigClass.__name__)+'('+str(datas)+', '+str(kwargs)+')')
80
81
                print(SPCE+"SERVER: Exception details where:",e.message, e.args )
            return Status(False, "I could not create the requested Figure. I tried: "+str(FigClass.__name__)+'('+str(datas)+', '+str(kwargs)+')'+" Exception details where:"+str(e.message)+str(e.args))
82
        
83
84
85
86
87
        # add the figure to the global index
        G_FIGURES[fig.getFigID()] = fig
        
        if fig.getFigID() in G_FIGURES :
            return Answer(fig.getFigID())
88

89
90
    def getFigByID(self,figID) :
        """ Identify the figure by ID and return it. On error it will return a Status Signal"""
91
92
93
94
95
96
97
98
99
100
        
        # Identify the figure
        fig = G_FIGURES.get(figID,None)
        if fig is None :
            if DEBUG:
                print(WARN+"The figure ID: "+figID+" does not exist.")
            return Status(False,"The figure ID: "+figID+" does not exist.")
        elif isinstance(fig,MyFig) :
            if DEBUG :
                print('Figure ',figID,' found in database')
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
            return fig
        
    def treatUpdateSyncFigure(self,content) :
        """ If client request an update of the keywords of a figure. This function forwards the request to the corresponding figure"""
        
        figID,kwargs = content
        fig = self.getFigByID(figID)
        
        # if an error occured forward the signal
        if isinstance(fig,Signal) :
            return fig
        
        status = fig.update(**kwargs)
        
        if status :
            return Status(True,'Kewords of figure ID: '+figID+' successfully updated')
        else :
            return Status(False,'Kewords of figure ID: '+figID+' could not be updated')

    def treatSyncFigFormatRawData(self,figID):
        
        # Identify the figure
        fig = self.getFigByID(figID)
        
        # if an error occured forward the signal
        if isinstance(fig,Signal) :
            return fig
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
        
        # Format the rawdata
        try:
            fig.formatRawData()
        except Exception as e:
            if DEBUG:
                print(WARN+"I couldn't format the rawdata.")
                print(SPCE+"SERVER: Exception details where:",e.message, e.args )
            return Status(False,"I couldn't format the rawdata. Exception details where:",e.message, e.args)
        
        # compose the answer
        datas = ()
        for ax in fig.get_axes():
            # ax.data is any user defined object
            # ax.packFormattedData returns it's string representation
            # to be unpacked by ax.unpackFormattedData
#            datas.append(ax.packFormattedData(ax.data))
            datas = datas + (ax.data,)
        
147
        return Answer(datas)
148
149
150
151
152
153
154
155
156
        
    def treatDeleteSyncFigure(self,figID) :
        """ Deletes the figure with ID figID from G_FIGURES """
        if figID in G_FIGURES :
            del G_FIGURES[figID]
            return Status(True,'Figure with ID '+str(figID)+' deleted from server.')
        else :
            return Status(False,'Figure with ID '+str(figID)+' not found on server side.')
        
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    
    def send(self,sig):
        # pickel the signal
        # send the str
        wf = self.server.socket.makefile(mode='wb')
        if debug:
            print('sending ',type(sig),' with content \"',sig.content,'\"')
        try :
            pickle.dump(sig,wf)
        except Exception as e:
            if DEBUG:
                print(SPCE+"SERVER: Exception details where:",e.message, e.args )
            return False
        wf.close()
        return True
        
    def waitForSignal(self):
        # wait for signal
        # unpickel
        
        rf = self.server.socket.makefile(mode='rb')
        try :
Yori Fournier's avatar
Yori Fournier committed
179
180
            unpickler = MplUnpickler(rf)
            response = unpickler.load()
181
182
183
184
185
186
187
188
189
190
191
192
193
            if DEBUG and isinstance(response,Signal):
                print('CLIENT Received: {} with content \"{}\"'.format(type(response),response.content))
        except EOFError :
            print('no answer received - or connection closed unexpectedly')
            response = None
        except Exception as e:
            print('unknown error while waiting for response')
            print(SPCE+"SERVER: Exception details where:",e.message, e.args )
            response = None
        rf.close()
        if isinstance(response,Signal) :
            return response
    
194
195
196
197
198
199
200
201
202
203
    def treatSig(self,sig):
        if   isinstance(sig,Query) :
            if   sig.queryType == sig.READDATA :
                return self.treatReadData(sig.content)
            elif sig.queryType == sig.NEWSYNCFIGURE :
                return self.treatNewSyncFigure(sig.content)
            elif sig.queryType == sig.UPDATESYNCFIGURE :
                return self.treatUpdateSyncFigure(sig.content) 
            elif sig.queryType == sig.SYNCFIGFORMATRAWDATA :
                return self.treatSyncFigFormatRawData(sig.content)
204
205
            elif sig.queryType == sig.DELETESYNCFIGURE :
                return self.treatDeleteSyncFigure(sig.content)
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
            else :
                self.servPrint('received unknown query type')
                return Status(False,"received unknown query type")
        elif isinstance(sig, Status) :
            if sig.value :
                pass #if it is just a positiv status message do nothing
            else :
                self.servPrint('the client Side reported of an error:')
                self.servPrint('----'+sig.content)
        elif isinstance(sig, Answer) :
            #~ #needed for server???
            pass
        elif isinstance(sig, Signal) :
            self.servPrint('received unknown signal')
            return Status(False,"received unknown signal")
        else : 
            self.servPrint('what is happening here??? received Object of type:')
            self.servPrint(str(sig))
            return Status(False,"received something totally diffenent")
            
    
    def handle(self):
        # self.rfile is a file-like object created by the handler;
        # we can now use e.g. readline() instead of raw recv() calls
        ## self.data = self.rfile.readline()#.strip()
231
        while self.server.running :
Yori Fournier's avatar
Yori Fournier committed
232
233
            unpickler = MplUnpickler(self.rfile)
            request = unpickler.load()
234
            reply = self.treatSig(request)
235
236
237
        # Likewise, self.wfile is a file-like object used to write back
        # to the client
        ## self.wfile.write(self.data.upper())
238
239
240
241
            if isinstance(reply,Signal) :
                if DEBUG:
                    self.servPrint("returning {}-Signal:".format(type(reply)))
                pickle.dump(reply,self.wfile)
242
243
244
245
246
247

class MplServer2(SocketServer.TCPServer):
    
    allow_reuse_address=True
    
    # DEFINE KNOWN I/O FUNCTIONS ---------------------------------------
Yori Fournier's avatar
Yori Fournier committed
248
    def defineKnownFunctions(self, functions):
249
250
        '''Function to overwrite in order to declare the known
        I/O functions by the server context.'''
Yori Fournier's avatar
Yori Fournier committed
251
        self.knownFunctions = functions
252
253

    # DEFINE KNOWN FIGURE CLASSES --------------------------------------
Yori Fournier's avatar
Yori Fournier committed
254
    def defineKnownFigures(self, figures):
255
256
        '''Function to overwrite in order to declare the known
        Figure classes by the server context.'''
Yori Fournier's avatar
Yori Fournier committed
257
        self.knownFigures = figures
258

Yori Fournier's avatar
Yori Fournier committed
259
    def __init__(self, ip='', port=52386, handler=MplHandler, knownFunctions=SERVER_IOFUNCTIONS, knownFigures=SERVER_FIGURES) :
260
261
262
263
        '''Intialisation of the server, defines known functions, known
        figure classes. It needs to be called.'''

        # Define functions and figure classes
Yori Fournier's avatar
Yori Fournier committed
264
265
266
        self.defineKnownFunctions(knownFunctions)
        self.defineKnownFigures(knownFigures)
        SocketServer.TCPServer.__init__(self, (ip, port), handler)
267
268
        
        self.initialized = True
269
        self.running = True
270
271