0e9539f84609079004eec1d85376b35ebc8227a8
[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                         print eventVarMap
266                         print capabilityMap
267
268                         #Check which capability
269                         variable = eventVarMap[eventList[i]]
270                         capability = capabilityMap[variable]
271
272                         #Write three events subsequently
273                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,2)\n")
274                         extractedEvents.write("\t\t\tif (event == 0) {\n")                      
275                         if capability == "capability.smokeDetector":
276                                 event = open("eventSimulator/smokeCarbonMonoxideClearEvent.groovy", "r")
277                         elif capability == "capability.carbonMonoxideDetector":
278                                 event = open("eventSimulator/carbonMonoxideClearEvent.groovy", "r")
279                         for line in event:
280                                 extractedEvents.write("\t\t" + line)
281                         event.close()
282                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
283                         if capability == "capability.smokeDetector":
284                                 event = open("eventSimulator/smokeCarbonMonoxideDetectedEvent.groovy", "r")
285                         elif capability == "capability.carbonMonoxideDetector":
286                                 event = open("eventSimulator/carbonMonoxideDetectedEvent.groovy", "r")
287                         for line in event:
288                                 extractedEvents.write("\t\t" + line)
289                         event.close()
290                         extractedEvents.write("\t\t\t} else {\n")
291                         if capability == "capability.smokeDetector":
292                                 event = open("eventSimulator/smokeCarbonMonoxideTestedEvent.groovy", "r")
293                         elif capability == "capability.carbonMonoxideDetector":
294                                 event = open("eventSimulator/carbonMonoxideTestedEvent.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 eventList[i] == "battery":
300                         event = open("eventSimulator/batteryChargeEvent.groovy", "r")
301                         for line in event:
302                                 extractedEvents.write(line)
303                         event.close()
304                 elif eventList[i] == "thermostatMode":
305                         #Write five events subsequently
306                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,4)\n")
307                         extractedEvents.write("\t\t\tif (event == 0) {\n")
308                         event = open("eventSimulator/thermostatAutoModeEvent.groovy", "r")                      
309                         for line in event:
310                                 extractedEvents.write("\t\t" + line)
311                         event.close()
312                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
313                         event = open("eventSimulator/thermostatCoolModeEvent.groovy", "r")
314                         for line in event:
315                                 extractedEvents.write("\t\t" + line)
316                         event.close()
317                         extractedEvents.write("\t\t\t} else if (event == 2) {\n")
318                         event = open("eventSimulator/thermostatEmergencyHeatModeEvent.groovy", "r")
319                         for line in event:
320                                 extractedEvents.write("\t\t" + line)
321                         event.close()
322                         extractedEvents.write("\t\t\t} else if (event == 3) {\n")
323                         event = open("eventSimulator/thermostatHeatModeEvent.groovy", "r")
324                         for line in event:
325                                 extractedEvents.write("\t\t" + line)
326                         event.close()
327                         extractedEvents.write("\t\t\t} else {\n")
328                         event = open("eventSimulator/thermostatOffModeEvent.groovy", "r")
329                         for line in event:
330                                 extractedEvents.write("\t\t" + line)
331                         event.close()
332                         extractedEvents.write("\t\t\t}\n")
333                 elif eventList[i] == "switch":
334                         #Write two events subsequently
335                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
336                         extractedEvents.write("\t\t\tif (event == 0) {\n")
337                         event = open("eventSimulator/switchOnEvent.groovy", "r")                        
338                         for line in event:
339                                 extractedEvents.write("\t\t" + line)
340                         event.close()
341                         extractedEvents.write("\t\t\t} else {\n")
342                         event = open("eventSimulator/switchOffEvent.groovy", "r")
343                         for line in event:
344                                 extractedEvents.write("\t\t" + line)
345                         event.close()
346                         extractedEvents.write("\t\t\t}\n")
347                 elif eventList[i] == "location": #Case for Location event
348                         #Write three events subsequently
349                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,2)\n")
350                         extractedEvents.write("\t\t\tif (event == 0) {\n")
351                         event = open("eventSimulator/locationHomeEvent.groovy", "r")                    
352                         for line in event:
353                                 extractedEvents.write("\t\t" + line)
354                         event.close()
355                         extractedEvents.write("\t\t\t} else if (event == 1) {\n")
356                         event = open("eventSimulator/locationAwayEvent.groovy", "r")
357                         for line in event:
358                                 extractedEvents.write("\t\t" + line)
359                         event.close()
360                         extractedEvents.write("\t\t\t} else {\n")
361                         event = open("eventSimulator/locationNightEvent.groovy", "r")
362                         for line in event:
363                                 extractedEvents.write("\t\t" + line)
364                         event.close()
365                         extractedEvents.write("\t\t\t}\n")
366                 elif eventList[i] == "acceleration":
367                         #Write two events subsequently
368                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
369                         extractedEvents.write("\t\t\tif (event == 0) {\n")
370                         event = open("eventSimulator/accelerationActiveEvent.groovy", "r")                      
371                         for line in event:
372                                 extractedEvents.write("\t\t" + line)
373                         event.close()
374                         extractedEvents.write("\t\t\t} else {\n")
375                         event = open("eventSimulator/accelerationInactiveEvent.groovy", "r")
376                         for line in event:
377                                 extractedEvents.write("\t\t" + line)
378                         event.close()
379                         extractedEvents.write("\t\t\t}\n")
380                 elif eventList[i] == "beacon":
381                         #Write two events subsequently
382                         extractedEvents.write("\t\t\tdef event = Verify.getInt(0,1)\n")
383                         extractedEvents.write("\t\t\tif (event == 0) {\n")
384                         event = open("eventSimulator/beaconPresenceEvent.groovy", "r")                  
385                         for line in event:
386                                 extractedEvents.write("\t\t" + line)
387                         event.close()
388                         extractedEvents.write("\t\t\t} else {\n")
389                         event = open("eventSimulator/beaconLeftEvent.groovy", "r")
390                         for line in event:
391                                 extractedEvents.write("\t\t" + line)
392                         event.close()
393                         extractedEvents.write("\t\t\t}\n")
394                 elif eventList[i] == "color":
395                         event = open("eventSimulator/colorChangeEvent.groovy", "r")
396                         for line in event:
397                                 extractedEvents.write(line)
398                         event.close()
399                 elif eventList[i] == "hue":
400                         event = open("eventSimulator/hueChangeEvent.groovy", "r")
401                         for line in event:
402                                 extractedEvents.write(line)
403                         event.close()
404                 elif eventList[i] == "saturation":
405                         event = open("eventSimulator/saturationChangeEvent.groovy", "r")
406                         for line in event:
407                                 extractedEvents.write(line)
408                         event.close()
409
410                 ###TODO: Add more events later
411                 extractedEvents.write("\t\t\tbreak\n")
412         extractedEvents.write("\t}\n")
413         extractedEvents.write("}\n")
414         
415 def CheckIfOnlyTouchEvents():
416         #Check and throw an error if it is all touch events
417         #This is called Direct-Direct interaction and we do not model-check for this case
418         onlyTouchEvents = True
419         for item in eventList:
420                 if item != "nfcTouch" and item != "app":
421                         onlyTouchEvents = False
422         if onlyTouchEvents is True and app1Subscribe is True and app2Subscribe is True:
423                 raise Exception("\n\nDirect-Direct Interaction detected: we are skipping this pair...\n\n")
424                 
425 #Extract objects to call functions from App1
426 F1 = open("Extractor/App1/App1.groovy", "r")
427 extractedFunctionsApp1 = open("Extractor/App1/extractedFunctionsApp1.groovy", "w+")
428 ExtractFunctions(F1, "App1")
429 F1.close()
430
431 #Extract objects to call functions from App2
432 F2 = open("Extractor/App2/App2.groovy", "r")
433 extractedFunctionsApp2 = open("Extractor/App2/extractedFunctionsApp2.groovy", "w+")
434 ExtractFunctions(F2, "App2")
435 F2.close()
436
437 #Prepare eventSimulator file while parsing the App1 and App2 files
438 extractedEvents = open("eventSimulator/eventSimulator.groovy", "w+")
439 CheckIfOnlyTouchEvents()
440 ExtractEvents(extractedEvents)
441 extractedEvents.close()
442
443 #Save the extracted methods and app1 in a same file to extract information
444 extractorFile = open("Extractor/extractorFile.groovy", "w+")
445 Extractor = open("Extractor/Extractor.groovy", "r")
446 F1 = open("Extractor/App1/App1.groovy", "r")
447
448 extractorFile.write("////////////////////\n")
449 extractorFile.write("@Field App\n")
450 extractorFile.write("App = \"App1\"")
451 extractorFile.write("\n")
452 for line in Extractor:
453         extractorFile.write(line)
454 extractorFile.write("\n\n")
455 for line in F1:
456         extractorFile.write(line)
457 extractorFile.close()
458 Extractor.close()
459 F1.close()
460 #Run the file to extract the objects
461 os.system("groovy -classpath lib/jpf.jar Extractor/extractorFile.groovy")
462
463
464 #Save the extracted methods and app2 in a same file to extract information
465 extractorFile = open("Extractor/extractorFile.groovy", "w+")
466 Extractor = open("Extractor/Extractor.groovy", "r")
467 F2 = open("Extractor/App2/App2.groovy", "r")
468
469 extractorFile.write("////////////////////\n")
470 extractorFile.write("@Field App\n")
471 extractorFile.write("App = \"App2\"")
472 extractorFile.write("\n")
473 for line in Extractor:
474         extractorFile.write(line)
475 extractorFile.write("\n\n")
476 for line in F2:
477         extractorFile.write(line)
478 #Run the file to extract the objects
479 extractorFile.close()
480 Extractor.close()
481 F2.close()
482 os.system("groovy -classpath lib/jpf.jar Extractor/extractorFile.groovy")
483
484
485
486