Merge branch '0.1.1'

Author: muppet9010

.gitignore

@@ -3,5 +3,5 @@ __pycache__
 currency data cache.json
 /Logs
 eventDefinitions.json
-config.json
-[!.]*.py.[!.]*.py
+/configs
+/config.json

Profiles/Factorio - Advanced Usage Example.json

@@ -8,8 +8,8 @@
             "filteredActions": [
                 {
                     "condition": "[ALL]",
-                    "manipulator": "",
-                    "action": "[BESTNAME] subscribed themselves"
+                    "manipulator": "'themselves'",
+                    "action": "[ACTION_SubscriptionBy]"
                 }
             ]
         },
@@ -19,8 +19,8 @@
             "filteredActions": [
                 {
                     "condition": "[ALL]",
-                    "manipulator": "",
-                    "action": "[BESTNAME] was subscribed by [gifter_display_name]"
+                    "manipulator": "'[gifter_display_name]'",
+                    "action": "[ACTION_SubscriptionBy]"
                 }
             ]
         },
@@ -43,6 +43,11 @@
                     "manipulator": "int([VALUE]/10)",
                     "action": "/a_custom_command [CALCVALUE] '[BESTNAME]'"
                 },
+                {
+                    "condition": "[VALUE] >= 0",
+                    "manipulator": "int([VALUE]/10)",
+                    "action": "I run with any value, including when the >10 action runs"
+                },
                 {
                     "condition": "[ALL]",
                     "manipulator": "myValue = floor([VALUE])\ncalcValue = myValue * 2",
@@ -71,6 +76,13 @@
             ]
         }
     ],
+    "actions": [
+        {
+            "name": "SubscriptionBy",
+            "description": "prints who subscribed and by whom. CALCVALUE must be provided as a string as otherwise it will be run like code",
+            "effect": "[BESTNAME] subscribed by [CALCVALUE]"
+        }
+    ],
     "options": {
         "twitchMysterSubGiftMode": "donator"
     }

README.md

@@ -8,7 +8,7 @@ def __init__(self, state):
         self._fileName = "config.json"
         self._settings = {}
         if Os.path.isfile(self._fileName):
-            with open(self._fileName, "r") as file:
+            with open(self._fileName, "r", encoding='utf-8') as file:
                 data = Json.load(file)
             file.closed
             self._settings = data
@@ -22,7 +22,6 @@ def _PopulateMissingConfigDefaults(self):
             "Currency ApiLayerAccessKey": "",
             "Streamlabs SocketApiToken": "",
             "Profile Default": "",
-            "Factorio PlayerName": "",
             "Rcon Server Address": "",
             "Rcon Server Port": 25575,
             "Rcon Server Password": "",

Source/Config.py

@@ -17,7 +17,7 @@ def GetRates(self):
         if Os.path.isfile(self.cacheFileName):
             self.logging.DebugLog(
                 "Trying to get currancy rates from cache file")
-            with open(self.cacheFileName, "r") as file:
+            with open(self.cacheFileName, "r", encoding='utf-8') as file:
                 data = Json.load(file)
             file.closed
             cacheDateTime = Datetime.date.fromtimestamp(data["timestamp"])
@@ -52,7 +52,7 @@ def _SourceRateData(self):
             self.state.RecordActivity(
                 self.state.translations.GetTranslation("Currency WebsiteDownloadFailed"))
             return False
-        with open(self.cacheFileName, "w") as file:
+        with open(self.cacheFileName, "w", encoding='utf-8') as file:
             file.write(Json.dumps(response))
         file.closed
         for name, rate in response["quotes"].items():

Source/Currency.py

@@ -175,11 +175,14 @@ def OnTestEventPlatformChanged(self, *args):
     def OnTestEventTypeChanged(self, *args):
         amountEnabled = False
         quantityEnabled = False
+        payloadCountEnabled = False
         if self.selectedTestEventType.get() != self.translations.GetTranslation("Gui SelectTestEventType"):
             amountEnabled = self.state.testEventUtils.GetAttribute(self.selectedTestEventPlatform.get(
             ), self.selectedTestEventType.get(), "valueInput")
             quantityEnabled = self.state.testEventUtils.GetAttribute(self.selectedTestEventPlatform.get(
             ), self.selectedTestEventType.get(), "quantityInput")
+            payloadCountEnabled = self.state.testEventUtils.GetAttribute(self.selectedTestEventPlatform.get(
+            ), self.selectedTestEventType.get(), "payloadInput")
         if amountEnabled:
             self.testEventValueLabel.config(state=TK.NORMAL)
             self.testEventValueInput.config(state=TK.NORMAL)
@@ -192,6 +195,10 @@ def OnTestEventTypeChanged(self, *args):
         else:
             self.testEventQuantityLabel.config(state=TK.DISABLED)
             self.testEventQuantityInput.config(state=TK.DISABLED)
-        self.testEventPayloadCountLabel.config(state=TK.NORMAL)
-        self.testEventPayloadCountInput.config(state=TK.NORMAL)
+        if payloadCountEnabled:
+            self.testEventPayloadCountLabel.config(state=TK.NORMAL)
+            self.testEventPayloadCountInput.config(state=TK.NORMAL)
+        else:
+            self.testEventPayloadCountLabel.config(state=TK.DISABLED)
+            self.testEventPayloadCountInput.config(state=TK.DISABLED)
         self.testEventButton.config(state=TK.NORMAL)

Source/Gui.py

@@ -33,7 +33,7 @@ def _TidyUpOldLogFiles(self, logFolder, currentDT, daysLogsToKeep, dateFormat):
     def Log(self, text):
         self.DebugLog(text)
         fileName = self.logFilePath
-        with open(fileName, "a") as file:
+        with open(fileName, "a", encoding='utf-8') as file:
             file.write(self.TimestampText(text) + "\n")
         file.closed
 
@@ -45,7 +45,7 @@ def DebugLog(self, text):
         if not self.debugLogging:
             return
         fileName = self.debugLogFilePath
-        with open(fileName, "a") as file:
+        with open(fileName, "a", encoding='utf-8') as file:
             file.write(self.TimestampText(text) + "\n")
         file.closed
 

Source/Logging.py

@@ -13,7 +13,7 @@ def __init__(self, state):
             Os.mkdir(self.profileFolder)
         else:
             for fileName in Os.listdir(self.profileFolder):
-                with open(self.profileFolder + "/" + fileName, "r") as file:
+                with open(self.profileFolder + "/" + fileName, "r", encoding='utf-8') as file:
                     data = Json.load(file)
                 file.closed
                 self.profiles[data["name"]] = Profile(data, self)
@@ -43,18 +43,15 @@ def __init__(self, profileData, profiles):
         else:
             self.options = Options(self, {})
 
-    def GetActionTextForEvent(self, event):
+    def GetActionTextsForEvent(self, event):
+        results = []
         for reaction in self.reactionPriorities[1]:
             if reaction.handlerName == event.handlerName:
-                result = reaction.GetActionTextForEvent(event)
-                if result != None:
-                    return result
+                results += reaction.GetActionTextsForEvent(event)
         for reaction in self.reactionPriorities[2]:
             if reaction.valueType == event.valueType:
-                result = reaction.GetActionTextForEvent(event)
-                if result != None:
-                    return result
-        return None
+                results += reaction.GetActionTextsForEvent(event)
+        return results
 
 
 class Reaction:
@@ -86,14 +83,15 @@ def __init__(self, reactionData, profile):
             else:
                 self.filterActionPriorities[1].append(filteredAction)
 
-    def GetActionTextForEvent(self, event):
+    def GetActionTextsForEvent(self, event):
+        results = []
         for filterAction in self.filterActionPriorities[1]:
             if filterAction.DoesEventTriggerAction(event):
-                return filterAction.GetActionText(event)
+                results.append(filterAction.GetActionText(event))
         for filterAction in self.filterActionPriorities[2]:
             if filterAction.DoesEventTriggerAction(event):
-                return filterAction.GetActionText(event)
-        return None
+                results.append(filterAction.GetActionText(event))
+        return results
 
     def GetPrintHandlerType(self):
         if self.handlerName != "":

Source/Profiles.py

@@ -9,11 +9,14 @@
 from Rcon import Rcon
 from Translations import Translations
 from TestEvents import TestEventUtils
+import random as Random
+import time as Time
+import threading as Threading
 
 
 class State():
     def __init__(self):
-        self.version = "0.1.0"
+        self.version = "0.1.1"
         self.config = Config(self)
         self.logging = Logging(self)
         self.config.LogMissingSettings()
@@ -110,6 +113,11 @@ def RecordActivity(self, text):
 
     def OnStreamlabsEventHandler(self, data):
         try:
+            random = Random.Random()
+            random.seed(Threading.get_ident())
+            sleepTime = random.random()
+            self.logging.DebugLog("Sleeping event for: " + str(sleepTime))
+            Time.sleep(sleepTime)
             self.logging.DebugLog(
                 "Streamlabs raw event data: " + str(data))
             events = StreamlabsEventUtils.GenerateEventPerPayload(self, data)
@@ -135,37 +143,39 @@ def OnStreamlabsEventHandler(self, data):
                 self.logging.DebugLog(
                     "Streamlabs processed event: " + str(event))
 
-                actionText = self.profiles.currentProfile.GetActionTextForEvent(
+                actionTexts = self.profiles.currentProfile.GetActionTextsForEvent(
                     event)
-                if actionText == None:
+                if len(actionTexts) == 0:
                     self.RecordActivity(
                         self.translations.GetTranslation("StreamlabsEvent NoProfileAction") + event.GetEventRawTitlesAsPrettyString())
                     self.logging.DebugLog(
                         "No profile action for: " + event.GetEventRawTitlesAsPrettyString())
                     return
-                actionType = ""
-                response = ""
-                if actionText == "":
-                    actionType = "Ignore event"
-                    self.logging.DebugLog(
-                        "NOTHING action specified for: " + event.GetEventRawTitlesAsPrettyString())
-                else:
-                    actionType = "Rcon command"
-                    try:
+                for actionText in actionTexts:
+                    actionType = ""
+                    response = ""
+                    if actionText == "":
+                        actionType = "Ignore event"
                         self.logging.DebugLog(
-                            "Doing Rcon command: " + actionText)
-                        response = self.rcon.SendCommand(actionText)
-                    except Exception as ex:
-                        self.logging.RecordException(ex, "Rcon event failed")
+                            "NOTHING action specified for: " + event.GetEventRawTitlesAsPrettyString())
+                    else:
+                        actionType = "Rcon command"
+                        try:
+                            self.logging.DebugLog(
+                                "Doing Rcon command: " + actionText)
+                            response = self.rcon.SendCommand(actionText)
+                        except Exception as ex:
+                            self.logging.RecordException(
+                                ex, "Rcon event failed")
+                            self.RecordActivity(
+                                self.translations.GetTranslation("Rcon CommandError") + actionText)
+                            return
+                    if response != "":
                         self.RecordActivity(
-                            self.translations.GetTranslation("Rcon CommandError") + actionText)
-                        return
+                            self.translations.GetTranslation("Rcon CommandResponseWarning") + response)
+                    self.logging.DebugLog("Action done: " + actionText)
                 self.RecordActivity(
                     self.translations.GetTranslation("StreamlabsEvent EventHandled") + event.GetEventRawTitlesAsPrettyString() + " : " + event.bestName + " : value " + str(event.value) + " : " + actionType)
-                if response != "":
-                    self.RecordActivity(
-                        self.translations.GetTranslation("Rcon CommandResponseWarning") + response)
-                self.logging.DebugLog("Action done: " + actionText)
         except Exception as ex:
             self.logging.RecordException(
                 ex, "OBS Event Handler Critical Error - This event won't be processed")
@@ -194,15 +204,17 @@ def OnTestEventButtonHandler(self):
                     self.RecordActivity(
                         self.translations.GetTranslation("TestEvent QuantityCountNotInt") + str(testEventQuantity))
                     return
-            testEventPayloadCount = self.gui.testEventPayloadCount.get()
-            try:
-                testEventPayloadCount = int(testEventPayloadCount)
-                if testEventPayloadCount <= 0:
-                    raise ValueError()
-            except:
-                self.RecordActivity(
-                    self.translations.GetTranslation("TestEvent PayloadCountNotInt") + str(testEventPayloadCount))
-                return
+            testEventPayloadCount = 1
+            if TestEventUtils.GetAttribute(testEventPlatform, testEventType, "payloadInput"):
+                try:
+                    testEventPayloadCount = self.gui.testEventPayloadCount.get()
+                    testEventPayloadCount = int(testEventPayloadCount)
+                    if testEventPayloadCount <= 0:
+                        raise ValueError()
+                except:
+                    self.RecordActivity(
+                        self.translations.GetTranslation("TestEvent PayloadCountNotInt") + str(testEventPayloadCount))
+                    return
             testEventArray = self.testEventUtils.GenerateTestEventArray(
                 testEventPlatform, testEventType, testEventValue, testEventQuantity, testEventPayloadCount)
             if len(testEventArray) > 0:
@@ -241,7 +253,7 @@ def Run(self):
     except:
         pass
     try:
-        state.logging.RecordException(
+        self.logging.RecordException(
             ex, "Application Critical Error - Application has been stopped")
     except:
         pass

Source/Streamlabs Rcon Integration.py

@@ -21,6 +21,9 @@ def __init__(self, state, platformString, typeString, payload):
         self.ignored = False
         self.rawMessage = payload
 
+        if "_id" in self.rawMessage:
+            self.id = self.rawMessage["_id"]
+
         if self.type == "donation" and self.platform == "":
             self.platform = "streamlabs"
         elif self.platform == "twitch_account" and self.type == "subscription" and "gifter" in self.rawMessage and self.rawMessage["gifter"] != None:
@@ -30,7 +33,6 @@ def __init__(self, state, platformString, typeString, payload):
             self.ignored = True
             return
 
-        self.id = self.rawMessage["_id"]
         if "display_name" in self.rawMessage.keys():
             self.bestName = self.rawMessage["display_name"]
         elif "name" in self.rawMessage.keys():
@@ -218,7 +220,7 @@ def FindAttributeTagsInString(string):
 
     @staticmethod
     def LoadEventDefinitions():
-        with open("eventDefinitions.json", "r") as file:
+        with open("eventDefinitions.json", "r", encoding='utf-8') as file:
             data = Json.load(file)
         file.closed
         StreamlabsEventUtils.handledEventTypes = data
@@ -290,7 +292,12 @@ def GenerateEventPerPayload(state, data):
             typeString = data["type"]
         else:
             typeString = ""
-        for payload in data["message"]:
+        # twitch alerts only have a dictionary as message and not an array of dictionaries like all other scenarios
+        if isinstance(data["message"], dict):
             events.append(StreamlabsEvent(
-                state, platformString, typeString, payload))
+                state, platformString, typeString, data["message"]))
+        else:
+            for payload in data["message"]:
+                events.append(StreamlabsEvent(
+                    state, platformString, typeString, payload))
         return events