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