ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-18 18:07:37 +03:00
Code Issues Projects Releases Wiki Activity

eddn: Set header up properly for all journal messages

Browse Source 
* New function `EDDN.add_header()`.
* It utilises new `this` members, set from `journal_entry()`.
This commit is contained in:
Athanasius 2022-11-22 17:26:32 +00:00
parent 06fa3629ea
commit 4a0518da9f
No known key found for this signature in database
GPG Key ID: 772697E181BB2767
1 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
plugins/eddn.py
View File

@ -66,6 +66,12 @@ class This:
"""Holds module globals."""
def __init__(self):
# Game version and build
self.game_version = ""
self.game_build = ""
# Commander Name
self.cmdr_name = ""
# Track if we're on foot
self.on_foot = False
# Track if we're docked
@ -906,17 +912,43 @@ class EDDN:
# 'Station data'
if config.get_int('output') & config.OUT_EDDN_SEND_STATION_DATA:
# And user has 'station data' configured to be sent
msg = self.add_header(msg)
msg_id = self.sender.add_message(cmdr, msg)
# 'Station data' is never delayed on construction of message
self.sender.send_message_by_id(msg_id)
elif config.get_int('output') & config.OUT_EDDN_SEND_NON_STATION:
# Any data that isn't 'station' is configured to be sent
msg = self.add_header(msg)
msg_id = self.sender.add_message(cmdr, msg)
if not (config.get_int('output') & config.OUT_EDDN_DELAY):
# No delay in sending configured, so attempt immediately
self.sender.send_message_by_id(msg_id)
def add_header(self, msg: MutableMapping[str, Any]) -> MutableMapping[str, Any]:
"""
Augment the given EDDN message with our header defaults.
NB: This should *only* be called for newly constructed messages, not
for either a legacy message or an already queued one!
:param msg: Message to be augmented
:return: The augmented version
"""
if 'header' in msg:
logger.error("Passed `msg` which already has a header")
return msg
msg['header'] = {
'softwareName': f'{applongname} [{system() if sys.platform != "darwin" else "Mac OS"}]',
'softwareVersion': str(appversion_nobuild()),
'uploaderID': this.cmdr_name,
'gameversion': this.game_version,
'gamebuild': this.game_build,
}
return msg
def export_journal_generic(self, cmdr: str, is_beta: bool, entry: Mapping[str, Any]) -> None:
"""
Send an EDDN event on the journal schema.
@ -1966,7 +1998,7 @@ def journal_entry( # noqa: C901, CCR001
"""
Process a new Journal entry.
:param cmdr: `str` - Name of currennt Cmdr.
:param cmdr: `str` - Name of current Cmdr.
:param is_beta: `bool` - True if this is a beta version of the Game.
:param system: `str` - Name of system Cmdr is in.
:param station: `str` - Name of station Cmdr is docked at, if applicable.
@ -1986,6 +2018,9 @@ def journal_entry( # noqa: C901, CCR001
entry = new_data
event_name = entry['event'].lower()
this.cmdr_name = cmdr
this.game_version = state['GameVersion']
this.game_build = state['GameBuild']
this.on_foot = state['OnFoot']
this.docked = state['IsDocked']