65c5cd75c40e302c044d005d1d7cc24d49af58ad
[smartthings-infrastructure.git] / Extractor / ExtractorScript.py
1 import os
2 readyToReturn = 0
3 ToReturn = ""
4 eventMap = []
5 app1Capabilities = []
6 app2Capabilities = []
7 app1Subscribe = False
8 app2Subscribe = False
9
10 def GetToken(f):
11         global readyToReturn
12         global ToReturn
13         Skip = ['\n', '\t', ' ']
14         Special = ["(", "\"", ":", ",", "{", "}", ")", "/", "*"]
15         S = ""
16         if (readyToReturn):
17                 readyToReturn = 0
18                 return ToReturn
19         ToReturn = ""
20         c = f.read(1)
21         while(True):
22                 if (c in Special):
23                         if (S != ""):
24                                 readyToReturn = 1
25                                 ToReturn = c
26                                 return S
27                         else:
28                                 return c
29                 elif (c in Skip):
30                         if (S != ""):
31                                 return S        
32                         else:
33                                 c = f.read(1)
34                                 continue
35                 S += c
36                 c = f.read(1)
37                 if not c:
38                         return "EOF"
39
40 def ExtractFunctions(F, appName):
41         global eventMap
42         global app1Subscribe
43         global app2Subscribe
44         Temp = GetToken(F)
45         while (Temp != "EOF"):
46                 if (Temp == "def" or Temp == "private"):
47                         Temp = GetToken(F)
48                         NameofFunc = Temp
49                         if (GetToken(F) != "="): #We have a function to create object for
50                                 if (appName == "App1"):
51                                         extractedFunctionsApp1.write("//Global Object for functions in subscribe method!\n")    
52                                         extractedFunctionsApp1.write("def %s = this.&" % NameofFunc)
53                                         extractedFunctionsApp1.write("%s\n" % NameofFunc)
54                                 else:
55                                         extractedFunctionsApp2.write("//Global Object for functions in subscribe method!\n")    
56                                         extractedFunctionsApp2.write("def %s = this.&" % NameofFunc)
57                                         extractedFunctionsApp2.write("%s\n" % NameofFunc)
58                 
59                 #Check subscribed events
60                 if (Temp == "subscribe"):
61                         if (appName == "App1"):
62                                 app1Subscribe = True
63                         else:
64                                 app2Subscribe = True
65                         while (Temp != "\"" and Temp != "app" and Temp != "location"):
66                                 Temp = GetToken(F)
67                         if Temp == "\"":
68                                 Temp = GetToken(F)
69                         if Temp not in eventMap:
70                                 eventMap.append(Temp)
71
72                 #Check and analyze capabilities for physical interaction
73                 AnalyzeCapabilities(Temp, appName)
74
75                 Temp = GetToken(F)
76         
77         #Warn if there is a potential for physical interaction
78         AnalyzePhysicalInteraction(app1Capabilities, app2Capabilities)
79         AnalyzePhysicalInteraction(app2Capabilities, app1Capabilities)
80
81                 
82
83 def AnalyzeCapabilities(Temp, appName):
84                         #Illuminance related
85         if (Temp == "capability.switch" or
86                         Temp == "capability.switchLevel" or
87                         Temp == "capability.illuminanceMeasurement" or
88                         #Motion related
89                         Temp == "capability.motionSensor" or
90                         #Water related
91                         Temp == "capability.valve" or
92                         Temp == "capability.waterSensor" or
93                         #Sound related
94                         Temp == "capability.musicPlayer" or
95                         Temp == "capability.alarm" or
96                         Temp == "capability.speechSynthesis" or
97                         Temp == "capability.soundSensor"):
98                 if (appName == "App1"):
99                         app1Capabilities.append(Temp)
100                 else:
101                         app2Capabilities.append(Temp)
102                         
103 def AnalyzePhysicalInteraction(app1Capab, app2Capab):
104         #Light
105         if ("capability.illuminanceMeasurement" in app1Capab) and ("capability.switch" in app2Capab or 
106                         "capability.switchLevel" in app2Capab):
107                 print ("\nWARNING: Potential PHYSICAL CONFLICT (light) detected between App1 and App2!\n")
108         #Motion
109         if ("capability.motionSensor" in app1Capab):
110                 print ("\nWARNING: Potential PHYSICAL CONFLICT (motion) detected between App1 and App2!\n")             
111         #Water
112         if ("capability.waterSensor" in app1Capab) and ("capability.valve" in app2Capab or 
113                         "capability.switch" in app2Capab):
114                 print ("\nWARNING: Potential PHYSICAL CONFLICT (water) detected between App1 and App2!\n")
115         #Sound
116         if ("capability.soundSensor" in app1Capab) and ("capability.musicPlayer" in app2Capab or 
117                         "capability.alarm" in app2Capab or "capability.speechSynthesis" in app2Capab):
118                 print ("\nWARNING: Potential PHYSICAL CONFLICT (sound) detected between App1 and App2!\n")
119
120 def ExtractEvents(extractedEvents):
121         global eventMap
122         extractedEvents.write("while(true) {\n")
123         extractedEvents.write("\tdef eventNumber = Verify.getInt(0,%d)\n" % (len(eventMap) - 1))
124         extractedEvents.write("\tswitch(eventNumber) {\n")
125         for i in range(len(eventMap)):
126                 extractedEvents.write("\t\tcase %d:\n" % i)
127                 if eventMap[i] == "lock":
128                         event = open("eventSimulator/lockEvent.groovy", "r")
129                         for line in event:
130                                 extractedEvents.write(line)
131                         event.close()
132                 elif eventMap[i] == "unlock":
133                         event = open("eventSimulator/unlockEvent.groovy", "r")
134                         for line in event:
135                                 extractedEvents.write(line)
136                         event.close()
137                 elif eventMap[i] == "contact.open":
138                         event = open("eventSimulator/contactOpenEvent.groovy", "r")
139                         for line in event:
140                                 extractedEvents.write(line)
141                         event.close()
142                 elif eventMap[i] == "contact.closed":
143                         event = open("eventSimulator/contactClosedEvent.groovy", "r")
144                         for line in event:
145                                 extractedEvents.write(line)
146                         event.close()
147                 elif eventMap[i] == "nfcTouch":
148                         event = open("eventSimulator/nfcTouchEvent.groovy", "r")
149                         for line in event:
150                                 extractedEvents.write(line)
151                         event.close()
152                 elif eventMap[i] == "app": #Case for Touched event
153                         event = open("eventSimulator/appTouchEvent.groovy", "r")
154                         for line in event:
155                                 extractedEvents.write(line)
156                         event.close()
157                 elif eventMap[i] == "button":
158                         #Write two events subsequently
159                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
160                         extractedEvents.write("\t\t\tif (event == 0) {\n")
161                         event = open("eventSimulator/buttonPushedEvent.groovy", "r")                    
162                         for line in event:
163                                 extractedEvents.write("\t\t" + line)
164                         event.close()
165                         extractedEvents.write("\t\t\t} else {\n")
166                         event = open("eventSimulator/buttonHeldEvent.groovy", "r")
167                         for line in event:
168                                 extractedEvents.write("\t\t" + line)
169                         event.close()
170                         extractedEvents.write("\t\t\t}\n")
171                 elif eventMap[i] == "presence":
172                         #Write two events subsequently
173                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
174                         extractedEvents.write("\t\t\tif (event == 0) {\n")
175                         event = open("eventSimulator/presencePresentEvent.groovy", "r")                 
176                         for line in event:
177                                 extractedEvents.write("\t\t" + line)
178                         event.close()
179                         extractedEvents.write("\t\t\t} else {\n")
180                         event = open("eventSimulator/presenceLeftEvent.groovy", "r")
181                         for line in event:
182                                 extractedEvents.write("\t\t" + line)
183                         event.close()
184                         extractedEvents.write("\t\t\t}\n")
185                 elif eventMap[i] == "doorState":
186                         #Write two events subsequently
187                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
188                         extractedEvents.write("\t\t\tif (event == 0) {\n")
189                         event = open("eventSimulator/doorOpenEvent.groovy", "r")                        
190                         for line in event:
191                                 extractedEvents.write("\t\t" + line)
192                         event.close()
193                         extractedEvents.write("\t\t\t} else {\n")
194                         event = open("eventSimulator/doorClosedEvent.groovy", "r")
195                         for line in event:
196                                 extractedEvents.write("\t\t" + line)
197                         event.close()
198                         extractedEvents.write("\t\t\t}\n")
199                 elif eventMap[i] == "motion":
200                         #Write two events subsequently
201                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
202                         extractedEvents.write("\t\t\tif (event == 0) {\n")
203                         event = open("eventSimulator/motionActiveEvent.groovy", "r")                    
204                         for line in event:
205                                 extractedEvents.write("\t\t" + line)
206                         event.close()
207                         extractedEvents.write("\t\t\t} else {\n")
208                         event = open("eventSimulator/motionInactiveEvent.groovy", "r")
209                         for line in event:
210                                 extractedEvents.write("\t\t" + line)
211                         event.close()
212                         extractedEvents.write("\t\t\t}\n")
213                 elif eventMap[i] == "smoke":
214                         #Write three events subsequently
215                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,2)\n")
216                         extractedEvents.write("\t\t\tif (event == 0) {\n")
217                         event = open("eventSimulator/smokeClearEvent.groovy", "r")                      
218                         for line in event:
219                                 extractedEvents.write("\t\t" + line)
220                         event.close()
221                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
222                         event = open("eventSimulator/smokeDetectedEvent.groovy", "r")
223                         for line in event:
224                                 extractedEvents.write("\t\t" + line)
225                         event.close()
226                         extractedEvents.write("\t\t\t} else {\n")
227                         event = open("eventSimulator/smokeTestedEvent.groovy", "r")
228                         for line in event:
229                                 extractedEvents.write("\t\t" + line)
230                         event.close()
231                         extractedEvents.write("\t\t\t}\n")
232                 elif eventMap[i] == "carbonMonoxide":
233                         #Write three events subsequently
234                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,2)\n")
235                         extractedEvents.write("\t\t\tif (event == 0) {\n")
236                         event = open("eventSimulator/carbonMonoxideClearEvent.groovy", "r")                     
237                         for line in event:
238                                 extractedEvents.write("\t\t" + line)
239                         event.close()
240                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
241                         event = open("eventSimulator/carbonMonoxideDetectedEvent.groovy", "r")
242                         for line in event:
243                                 extractedEvents.write("\t\t" + line)
244                         event.close()
245                         extractedEvents.write("\t\t\t} else {\n")
246                         event = open("eventSimulator/carbonMonoxideTestedEvent.groovy", "r")
247                         for line in event:
248                                 extractedEvents.write("\t\t" + line)
249                         event.close()
250                         extractedEvents.write("\t\t\t}\n")
251                 elif eventMap[i] == "battery":
252                         event = open("eventSimulator/batteryChargeEvent.groovy", "r")
253                         for line in event:
254                                 extractedEvents.write(line)
255                         event.close()
256                 elif eventMap[i] == "thermostatMode":
257                         #Write five events subsequently
258                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,4)\n")
259                         extractedEvents.write("\t\t\tif (event == 0) {\n")
260                         event = open("eventSimulator/thermostatAutoModeEvent.groovy", "r")                      
261                         for line in event:
262                                 extractedEvents.write("\t\t" + line)
263                         event.close()
264                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
265                         event = open("eventSimulator/thermostatCoolModeEvent.groovy", "r")
266                         for line in event:
267                                 extractedEvents.write("\t\t" + line)
268                         event.close()
269                         extractedEvents.write("\t\t\t} else if (event == 2) {\n")
270                         event = open("eventSimulator/thermostatEmergencyHeatModeEvent.groovy", "r")
271                         for line in event:
272                                 extractedEvents.write("\t\t" + line)
273                         event.close()
274                         extractedEvents.write("\t\t\t} else if (event == 3) {\n")
275                         event = open("eventSimulator/thermostatHeatModeEvent.groovy", "r")
276                         for line in event:
277                                 extractedEvents.write("\t\t" + line)
278                         event.close()
279                         extractedEvents.write("\t\t\t} else {\n")
280                         event = open("eventSimulator/thermostatOffModeEvent.groovy", "r")
281                         for line in event:
282                                 extractedEvents.write("\t\t" + line)
283                         event.close()
284                         extractedEvents.write("\t\t\t}\n")
285                 elif eventMap[i] == "switch":
286                         #Write two events subsequently
287                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
288                         extractedEvents.write("\t\t\tif (event == 0) {\n")
289                         event = open("eventSimulator/switchOnEvent.groovy", "r")                        
290                         for line in event:
291                                 extractedEvents.write("\t\t" + line)
292                         event.close()
293                         extractedEvents.write("\t\t\t} else {\n")
294                         event = open("eventSimulator/switchOffEvent.groovy", "r")
295                         for line in event:
296                                 extractedEvents.write("\t\t" + line)
297                         event.close()
298                         extractedEvents.write("\t\t\t}\n")
299                 elif eventMap[i] == "location": #Case for Location event
300                         #Write three events subsequently
301                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,2)\n")
302                         extractedEvents.write("\t\t\tif (event == 0) {\n")
303                         event = open("eventSimulator/locationHomeEvent.groovy", "r")                    
304                         for line in event:
305                                 extractedEvents.write("\t\t" + line)
306                         event.close()
307                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
308                         event = open("eventSimulator/locationAwayEvent.groovy", "r")
309                         for line in event:
310                                 extractedEvents.write("\t\t" + line)
311                         event.close()
312                         extractedEvents.write("\t\t\t} else {\n")
313                         event = open("eventSimulator/locationNightEvent.groovy", "r")
314                         for line in event:
315                                 extractedEvents.write("\t\t" + line)
316                         event.close()
317                         extractedEvents.write("\t\t\t}\n")
318
319                 ###TODO: Add more events later
320                 extractedEvents.write("\t\t\tbreak\n")
321         extractedEvents.write("\t}\n")
322         #extractedEvents.write("\tcounter--\n")
323         extractedEvents.write("}\n")
324         
325 def CheckIfOnlyTouchEvents():
326         #Check and throw an error if it is all touch events
327         #This is called Direct-Direct interaction and we do not model-check for this case
328         onlyTouchEvents = True
329         for item in eventMap:
330                 if item != "nfcTouch" and item != "app":
331                         onlyTouchEvents = False
332         if onlyTouchEvents is True and app1Subscribe is True and app2Subscribe is True:
333                 raise Exception("\n\nDirect-Direct Interaction detected: we are skipping this pair...\n\n")
334                 
335 #Extract objects to call functions from App1
336 F1 = open("Extractor/App1/App1.groovy", "r")
337 extractedFunctionsApp1 = open("Extractor/App1/extractedFunctionsApp1.groovy", "w+")
338 ExtractFunctions(F1, "App1")
339 F1.close()
340
341 #Extract objects to call functions from App2
342 F2 = open("Extractor/App2/App2.groovy", "r")
343 extractedFunctionsApp2 = open("Extractor/App2/extractedFunctionsApp2.groovy", "w+")
344 ExtractFunctions(F2, "App2")
345 F2.close()
346
347 #Prepare eventSimulator file while parsing the App1 and App2 files
348 extractedEvents = open("eventSimulator/eventSimulator.groovy", "w+")
349 CheckIfOnlyTouchEvents()
350 ExtractEvents(extractedEvents)
351 extractedEvents.close()
352
353 #Save the extracted methods and app1 in a same file to extract information
354 extractorFile = open("Extractor/extractorFile.groovy", "w+")
355 Extractor = open("Extractor/Extractor.groovy", "r")
356 F1 = open("Extractor/App1/App1.groovy", "r")
357
358 extractorFile.write("////////////////////\n")
359 extractorFile.write("@Field App\n")
360 extractorFile.write("App = \"App1\"")
361 extractorFile.write("\n")
362 for line in Extractor:
363         extractorFile.write(line)
364 extractorFile.write("\n\n")
365 for line in F1:
366         extractorFile.write(line)
367 extractorFile.close()
368 Extractor.close()
369 F1.close()
370 #Run the file to extract the objects
371 os.system("groovy Extractor/extractorFile.groovy")
372
373
374 #Save the extracted methods and app2 in a same file to extract information
375 extractorFile = open("Extractor/extractorFile.groovy", "w+")
376 Extractor = open("Extractor/Extractor.groovy", "r")
377 F2 = open("Extractor/App2/App2.groovy", "r")
378
379 extractorFile.write("////////////////////\n")
380 extractorFile.write("@Field App\n")
381 extractorFile.write("App = \"App2\"")
382 extractorFile.write("\n")
383 for line in Extractor:
384         extractorFile.write(line)
385 extractorFile.write("\n\n")
386 for line in F2:
387         extractorFile.write(line)
388 #Run the file to extract the objects
389 extractorFile.close()
390 Extractor.close()
391 F2.close()
392 os.system("groovy Extractor/extractorFile.groovy")
393
394
395
396