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