add basic support of subMysteryGift

muppet9010 · muppet9010 · commit 57d4d1b5fea4 · 2019-06-14T22:53:40.000+01:00
diff --git a/Profiles/Factorio - Print Most Fancy.json b/Profiles/Factorio - Print Most Fancy.json
@@ -36,7 +36,7 @@
         },
         {
             "platform": "twitch_account",
-            "type": "subscription_gift",
+            "type": "subscriptionGift",
             "filteredActions": [
                 {
                     "condition": "[VALUE] >= 5",
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ Profile configuration files must be created with knowledge of quote escaping. Th
 
 Manipulator script's are special in that they support raw python code that will be executed within a Python exec() function in addition to a python expression that is executed within a Python eval() function. The event handler will try to eval() the manipulator script first and should it error then try to exec() the manipulator script. As the manipulator script is supplied via the profile JSON file it must be in a single line format with `\n` for the line breaks. The Python maths module is included within the execution environment. The local variable `calcValue` is passed out of the exec environment as the value of `CALCVALUE`. See the `Factorio - Advanced Usage Example.json` for examples of the some of these combinations.
 
-The config has a `Test Mode` option. When enabled it prints the RCON commands to the activity window rather than sending them. It also skips the RCON connection test which the Start button is clicked within the app. In effect not doing any RCON commands.
+The config has a `Rcon No Commands` option. When enabled it prints the RCON commands to the activity window rather than sending them. It also skips the RCON connection test which the Start button is clicked within the app. In effect not doing any RCON commands.
 
 
 Development Building
diff --git a/Source/Config.py b/Source/Config.py
@@ -27,7 +27,7 @@ def _PopulateMissingConfigDefaults(self):
             "Rcon Server Port": 25575,
             "Rcon Server Password": "",
             "Rcon Test Command": "/version",
-            "Test Mode": False
+            "Rcon No Commands": False
         }
         for name, value in defaults.items():
             if not name in self._settings:
diff --git a/Source/Profiles.py b/Source/Profiles.py
@@ -67,12 +67,13 @@ def __init__(self, reactionData, profile):
             self.handlerName = StreamlabsEventUtils.MakeHandlerString(
                 self.platform, self.type)
             if self.handlerName not in StreamlabsEventUtils.handledEventTypes.keys():
-                self.logging.LogQuit(
-                    "invalid event handler type: " + self.handlerName)
+                self.logging.LogQuit(self.profile.name +
+                                     " : has invalid event handler type: " + self.handlerName)
         else:
             self.valueType = reactionData["valueType"]
             if self.valueType not in ["money", "follow", "viewer"]:
-                self.logging.LogQuit("invalid valueType: " + self.valueType)
+                self.logging.LogQuit(
+                    self.profile.name + " : has invalid valueType: " + self.valueType)
         self.filterActionPriorities = {1: [], 2: []}
         for filteredActionData in reactionData["filteredActions"]:
             filteredAction = FilteredAction(filteredActionData, self)
@@ -101,30 +102,31 @@ class FilteredAction:
     def __init__(self, filteredActionData, reaction):
         self.reaction = reaction
         self.logging = self.reaction.profile.profiles.state.logging
+        errorLoggingParentsString = reaction.profile.name + " : " + reaction.handlerName
 
         self.condition = filteredActionData["condition"]
         if self.condition == "":
-            self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
+            self.logging.LogQuit(errorLoggingParentsString + " : '" + self.reaction.GetPrintHandlerType() +
                                  "' condition can not be blank")
         eventAttributeCheckResult = StreamlabsEventUtils.IsBadEventAttritubeUsed(
             self.reaction.handlerName, self.condition, False)
         if eventAttributeCheckResult != "":
-            self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
+            self.logging.LogQuit(errorLoggingParentsString + " : '" + self.reaction.GetPrintHandlerType() +
                                  "' condition error: " + eventAttributeCheckResult)
         scriptParseCheck = StreamlabsEventUtils.IsScriptValid(self.condition)
         if scriptParseCheck != "":
-            self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
+            self.logging.LogQuit(errorLoggingParentsString + " : '" + self.reaction.GetPrintHandlerType() +
                                  "' has an invalid condition script:\n" + scriptParseCheck)
 
         self.manipulator = filteredActionData["manipulator"]
         eventAttributeCheckResult = StreamlabsEventUtils.IsBadEventAttritubeUsed(
             self.reaction.handlerName, self.manipulator, False)
         if eventAttributeCheckResult != "":
-            self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
+            self.logging.LogQuit(errorLoggingParentsString + " : '" + self.reaction.GetPrintHandlerType() +
                                  "' manipulator error: " + eventAttributeCheckResult)
         scriptParseCheck = StreamlabsEventUtils.IsScriptValid(self.manipulator)
         if scriptParseCheck != "":
-            self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
+            self.logging.LogQuit(errorLoggingParentsString + " : '" + self.reaction.GetPrintHandlerType() +
                                  "' has an invalid manipulator script:\n" + scriptParseCheck)
 
         self.actionText = ""
@@ -137,20 +139,20 @@ def __init__(self, filteredActionData, reaction):
                 eventAttributeCheckResult = StreamlabsEventUtils.IsBadEventAttritubeUsed(
                     self.reaction.handlerName, self.action.effect, True)
                 if eventAttributeCheckResult != "":
-                    self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() + "' referenced action " +
+                    self.logging.LogQuit(errorLoggingParentsString + " : '" + self.reaction.GetPrintHandlerType() + "' referenced action " +
                                          actionName + " which has action text error: " + eventAttributeCheckResult)
             else:
-                self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
+                self.logging.LogQuit(errorLoggingParentsString + " : '" + self.reaction.GetPrintHandlerType() +
                                      "' referenced non-existent action : " + actionName)
         else:
             self.actionText = action
             if self.actionText == "":
-                self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
+                self.logging.LogQuit(errorLoggingParentsString + " : '" + self.reaction.GetPrintHandlerType() +
                                      "' action can not be blank")
             eventAttributeCheckResult = StreamlabsEventUtils.IsBadEventAttritubeUsed(
                 self.reaction.handlerName, self.actionText, True)
             if eventAttributeCheckResult != "":
-                self.logging.LogQuit("'" + self.reaction.GetPrintHandlerType() +
+                self.logging.LogQuit(errorLoggingParentsString + " : '" + self.reaction.GetPrintHandlerType() +
                                      "' action text error: " + eventAttributeCheckResult)
 
     def DoesEventTriggerAction(self, event):
diff --git a/Source/Rcon.py b/Source/Rcon.py
@@ -12,7 +12,7 @@ def __init__(self, state):
         self.testCommand = self.state.config.GetSetting("Rcon Test Command")
 
     def TestConnection(self):
-        if self.state.config.GetSetting("Test Mode"):
+        if self.state.config.GetSetting("Rcon No Commands"):
             return True
         try:
             self.SendCommand(self.testCommand)
@@ -24,9 +24,9 @@ def TestConnection(self):
             return False
 
     def SendCommand(self, commandString):
-        if self.state.config.GetSetting("Test Mode"):
+        if self.state.config.GetSetting("Rcon No Commands"):
             self.state.RecordActivity(
-                self.state.translations.GetTranslation("Rcon TestMode") + commandString)
+                self.state.translations.GetTranslation("Rcon NoCommand") + commandString)
             return ""
         with MCRcon(self.serverAddress, self.serverPassword, self.serverPort) as mcr:
             return mcr.command(commandString)
diff --git a/Source/StreamlabsEvent.py b/Source/StreamlabsEvent.py
@@ -59,7 +59,7 @@ def __init__(self, state, data):
         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:
-            self.type = "subscription_gift"
+            self.type = "subscriptionGift"
         self.handlerName = StreamlabsEventUtils.MakeHandlerString(
             self.platform, self.type)
 
@@ -100,7 +100,7 @@ def IsHandledEvent(self):
             return False
 
     def ShouldIgnoreEvent(self):
-        if (self.type == "streamlabels") or (self.type == "streamlabels.underlying") or (self.type == "alertPlaying") or (self.type == "subscription-playing") or (self.type == "rollEndCredits") or (self.type == "subMysteryGift") or (self.type == "eventListSettingsUpdate"):
+        if (self.type == "streamlabels") or (self.type == "streamlabels.underlying") or (self.type == "alertPlaying") or (self.type == "subscription-playing") or (self.type == "rollEndCredits") or (self.type == "eventListSettingsUpdate"):
             return True
         if (self.platform == "widget"):
             return True
@@ -127,15 +127,23 @@ def PopulateNormalisedData(self):
         elif (self.handlerName == "twitch_account-bits"):
             self.valueType = "money"
             self.value = round(float(self.rawMessage["amount"]) / 100, 2)
-        elif (self.handlerName == "twitch_account-subscription") or (self.handlerName == "twitch_account-subscription_gift"):
+        elif (self.handlerName == "twitch_account-subscription") or (self.handlerName == "twitch_account-subscriptionGift"):
             self.valueType = "money"
             subPlan = self.rawMessage["sub_plan"]
-            if subPlan == "Prime" or subPlan == "1000":
-                self.value = 5
-            elif subPlan == "2000":
-                self.value = 10
-            elif subPlan == "3000":
-                self.value = 25
+            subValue = StreamlabsEventUtils.GetTwitchSubscriptionValue(subPlan)
+            if subValue != None:
+                self.value = subValue
+            else:
+                self.state.RecordActivity(
+                    self.state.translations.GetTranslation("StreamlabsEvent UnrecognisedTwitchSubscriptionType") + subPlan)
+                return False
+        elif (self.handlerName == "twitch_account-subMysteryGift"):
+            self.bestName = self.rawMessage["gifter_display_name"]
+            self.valueType = "money"
+            subPlan = self.rawMessage["sub_plan"]
+            subValue = StreamlabsEventUtils.GetTwitchSubscriptionValue(subPlan)
+            if subValue != None:
+                self.value = subValue * self.rawMessage["amount"]
             else:
                 self.state.RecordActivity(
                     self.state.translations.GetTranslation("StreamlabsEvent UnrecognisedTwitchSubscriptionType") + subPlan)
@@ -264,3 +272,14 @@ def ProcessExecScript(scriptString):
         script = "from math import *\n" + scriptString + "\n"
         exec(script, globals, locals)
         return locals["calcValue"]
+
+    @staticmethod
+    def GetTwitchSubscriptionValue(subPlan):
+        if subPlan == "Prime" or subPlan == "1000":
+            return 5
+        elif subPlan == "2000":
+            return 10
+        elif subPlan == "3000":
+            return 25
+        else:
+            return None
diff --git a/Source/Translations.py b/Source/Translations.py
@@ -30,7 +30,7 @@ def LoadLocalisedTexts(self, language):
                 "Rcon CommandError": "ERROR: Rcon command failed, run manually: ",
                 "Rcon CommandResponseWarning": "WARNING: Rcon got response from server: ",
                 "Rcon TestErrorMessage": "Rcon connection test message: ",
-                "Rcon TestMode": "Rcon Test Mode: "
+                "Rcon NoCommand": "Rcon Test Mode: "
             }
 
     def GetTranslation(self, key):
diff --git a/Source/config.sample.json b/Source/config.sample.json
@@ -9,5 +9,5 @@
     "Rcon Server Port": 25575,
     "Rcon Server Password": "",
     "Rcon Test Command": "/version",
-    "Test Mode": false
+    "Rcon No Commands": false
 }
diff --git a/Source/eventDefinitions.json b/Source/eventDefinitions.json
@@ -74,6 +74,7 @@
         }
     },
     "twitch_account-subscription": {
+        "_comment": "When a user gets themselves a subscription",
         "name": {
             "valueType": "text string",
             "description": "the username of the person who did the event"
@@ -95,7 +96,8 @@
             "description": "the number twitch uses to identify each sub tier: Prime, 1000, 2000, 3000"
         }
     },
-    "twitch_account-subscription_gift": {
+    "twitch_account-subscriptionGift": {
+        "_comment": "When a user is gifted a subscription",
         "name": {
             "valueType": "text string",
             "description": "the username of the person who received the subscription"
@@ -125,6 +127,29 @@
             "description": "the display name of the person who gifted the subscription"
         }
     },
+    "twitch_account-subMysteryGift": {
+        "_comment": "When a user gifts a number of subscriptions to the community",
+        "name": {
+            "valueType": "text string",
+            "description": "the username of the person who did the event"
+        },
+        "gifter": {
+            "valueType": "text string",
+            "description": "the username of the person who gifted the subscription"
+        },
+        "gifter_display_name": {
+            "valueType": "text string",
+            "description": "the display name of the person who gifted the subscription"
+        },
+        "amount": {
+            "valueType": "number",
+            "description": "the number of subscriptions gifted to the community"
+        },
+        "sub_plan": {
+            "valueType": "number",
+            "description": "the number twitch uses to identify each sub tier: Prime, 1000, 2000, 3000"
+        }
+    },
     "twitch_account-bits": {
         "name": {
             "valueType": "text string",
diff --git a/ToDo.txt b/ToDo.txt
@@ -10,9 +10,7 @@ Handle paused Factorio server accepting but not reply to RCON command. It will h
 
 
 
+At present a mysterySubGift will trigger plus each recipient will trigger the receiving subscription event. As mysterySubGift event comes first this needs to be monitored and receieved sub gift events ignored appropariately.
 
 
-
-add option for getting gift subscriptions from the gifter view as well as from the receiver view
-
 can have multiple payloads per event. need to split these up to separate events internally.
diff --git a/event samples.txt b/event samples.txt
@@ -14,21 +14,31 @@ YOUTUBE TEST WIDGETS
 
 TWITCH REAL WORLD
 
+SUB:
 20:01:04 : Streamlabs raw event received: {'type': 'subscription', 'message': [{'name': 'user', 'display_name': 'UsEr', 'months': '4', 'message': 'haha add some more parts :)', 'emotes': '1:25-26', 'sub_plan': '1000', 'sub_plan_name': 'Channel\\sSubscription\\s(streamer)', 'sub_type': 'resub', 'gifter': None, 'subscriber_twitch_id': '12345678', 'streak_months': '2', '_id': 'f5b4860c38313d4564d277ccc521a4a0', 'event_id': 'f5b4860c38313d4564d277ccc521a4a0'}], 'for': 'twitch_account'}
 
+SUBS GIFTED TO COMMUNITY (GIVER):
+{type: 'subMysteryGift',  message: [ { sub_plan: '1000', sub_type: 'submysterygift', gifter: 'user1', gifter_display_name: 'UsEr1', name: 'user1', amount: '1', _id: 'bc04a15a6755024aeece5bf932717054', event_id: 'bc04a15a6755024aeece5bf932717054' } ], for: 'twitch_account'}
+
+GIFTED SUB RECEIVED:
 18:09:23 : Streamlabs supported raw event received: {'type': 'subscription', 'message': [{'name': 'user1', 'display_name': 'UsEr1', 'months': '1', 'message': None, 'emotes': None, 'sub_plan': '1000', 'sub_plan_name': 'Channel\\sSubscription\\s(streamer)', 'sub_type': 'subgift', 'gifter': 'user2', 'gifter_display_name': 'UsEr2', 'streak_months': None, 'gifter_twitch_id': '0123456', 'subscriber_twitch_id': '5678900', '_id': 'e9d61c910409da7539562adcdfda8ae8', 'event_id': 'e9d61c910409da7539562adcdfda8ae8'}], 'for': 'twitch_account'}
 
+FOLLOW:
 21:05:14 : Streamlabs raw event received: {'type': 'follow', 'message': [{'created_at': '2019-05-14 20:05:00', 'id': '12345678', 'name': 'UsEr', '_id': '7b80748a12eec3c274cc46631bb8908f', 'event_id': '7b80748a12eec3c274cc46631bb8908f'}], 'for': 'twitch_account'}
 
 21:21:55 : Streamlabs raw event received: {'type': 'bits', 'message': [{'id': 'e1ded2fa-9b63-421a-92c9-74e147b55a96', 'name': 'user', 'display_name': 'UsEr', 'amount': '500', 'emotes': None, 'message': 'willlococheer500', '_id': 'c1f8c7a360456152d09cda8330da17e9', 'event_id': 'c1f8c7a360456152d09cda8330da17e9'}], 'for': 'twitch_account'}
 
+DONATION:
 21:22:41 : Streamlabs raw event received: {'type': 'donation', 'message': [{'id': 12345678, 'name': 'UsEr', 'amount': '5.0000000000', 'formatted_amount': '｣5.00', 'formattedAmount': '｣5.00', 'message': 'No Help!', 'currency': 'GBP', 'emotes': '', 'iconClassName': 'fab paypal', 'to': {'name': 'StreamerNaMe'}, 'from': 'UsEr', 'from_user_id': None, 'donation_currency': 'GBP', '_id': '7c4d7e3b4b79d5e1346e4b99b150b94f'}], 'event_id': 'evt_48f0fe1b9ff83cc086f58791bfead86a'}
 
+HOST:
 00:37:01 : Streamlabs supported raw event received: {'type': 'host', 'message': [{'name': 'UsEr', 'viewers': 157, 'type': 'manual', '_id': '47740b852ebfe74364d1d2123e2cec35', 'event_id': '47740b852ebfe74364d1d2123e2cec35'}], 'for': 'twitch_account'}
 
+RAID:
 22:43:07 : Streamlabs supported raw event received: {'type': 'raid', 'message': [{'id': 'a7ca29ca-03c8-4857-b9d4-915fa03fc275', 'name': 'user', 'display_name': 'UsEr', 'raiders': '28', '_id': 'a7ca29ca-03c8-4857-b9d4-915fa03fc275', 'event_id': 'a7ca29ca-03c8-4857-b9d4-915fa03fc275'}], 'for': 'twitch_account'}
 
+PLEDGE:
 19:37:29 : Streamlabs raw event data: {'type': 'pledge', 'message': [{'name': 'UsEr', 'isTest': True, 'formatted_amount': '£56.00', 'amount': 56, 'currency': 'GBP', 'to': {'name': 'StReAmErNaMe'}, 'from': 'Real Name', '_id': '938e6fdb71d5b11a19d170c3dbca555c'}], 'for': 'patreon', 'event_id': 'evt_a5f4b15b617c16d498f8fdf6d0865aaa'}
 
-multiple payload entries per event (any of them potentially):
+MULTIPLE PAYLOAD ENTRIES PER EVENT (ANY OF THEM POTENTIALLY):
 00:00:14 : Streamlabs event errored during initial handling: {id: '', platform: 'twitch_account', type: 'follow', errored: 'True', ignored: 'False', handlerName: '', valueType: '', value: '0.0', bestName: '', rawData: {'type': 'follow', 'message': [{'created_at': '2019-06-12 23:00:00', 'id': '12345678', 'name': 'UsEr1', '_id': '34ba6c0ce4412ccacf965ae4042076fa', 'event_id': '34ba6c0ce4412ccacf965ae4042076fa'}, {'created_at': '2019-06-12 22:59:56', 'id': '56789056789', 'name': 'UsEr2', '_id': '1f1ebd9a598f64fad10875baefb89f5b', 'event_id': '1f1ebd9a598f64fad10875baefb89f5b'}], 'for': 'twitch_account'}}

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`	`},`
`37`	`37`	`{`
`38`	`38`	`"platform": "twitch_account",`
`39`		`- "type": "subscription_gift",`
	`39`	`+ "type": "subscriptionGift",`
`40`	`40`	`"filteredActions": [`
`41`	`41`	`{`
`42`	`42`	`"condition": "[VALUE] >= 5",`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ def _PopulateMissingConfigDefaults(self):`
`27`	`27`	`"Rcon Server Port": 25575,`
`28`	`28`	`"Rcon Server Password": "",`
`29`	`29`	`"Rcon Test Command": "/version",`
`30`		`- "Test Mode": False`
	`30`	`+ "Rcon No Commands": False`
`31`	`31`	`}`
`32`	`32`	`for name, value in defaults.items():`
`33`	`33`	`if not name in self._settings:`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ def LoadLocalisedTexts(self, language):`
`30`	`30`	`"Rcon CommandError": "ERROR: Rcon command failed, run manually: ",`
`31`	`31`	`"Rcon CommandResponseWarning": "WARNING: Rcon got response from server: ",`
`32`	`32`	`"Rcon TestErrorMessage": "Rcon connection test message: ",`
`33`		`- "Rcon TestMode": "Rcon Test Mode: "`
	`33`	`+ "Rcon NoCommand": "Rcon Test Mode: "`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`def GetTranslation(self, key):`
Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,5 @@`
`9`	`9`	`"Rcon Server Port": 25575,`
`10`	`10`	`"Rcon Server Password": "",`
`11`	`11`	`"Rcon Test Command": "/version",`
`12`		`- "Test Mode": false`
	`12`	`+ "Rcon No Commands": false`
`13`	`13`	`}`