E:D Market Connector

Release 3.44

+ h2 { font-size: 105%; }

Release 3.44

CHANGE OF MAINTAINER

Due to a lack of time to give the project the attention it needs Marginal has handed over ownership of the EDMarketConnector GitHub repository to the EDCD (Elite Dangerous Community Developers) organisation.

@@ -17,2221 +21,232 @@

Version increased to 3.4.4.0 / 3.44.
URL the application checks for updates changed to point to github,

]]>

Release 5.10.4

body { font-family:"Segoe UI","Tahoma"; font-size: 75%; } h2 { font-family:"Segoe UI","Tahoma"; font-size: 105%; } -

We now test against, and package with, Python 3.11.7.

As a result, we do not support Windows 7, 8, or 8.1.
-

Release 5.10.4

This release contains updated dependencies, modules files, translations, and adds two new EDDN schemas. It also -adds Turkish translations to EDMC!

We now sign our code! This does mean that built EXEs are now slightly modified on our developer's machines. -For information on what this means, and opt-out options, please visit https://github.com/EDCD/EDMarketConnector/wiki/Code-Signing-and-EDMC

Changes and Enhancements

Adds Turkish Translations to EDMC
Adds DockingDenied and DockingGranted EDDN Schemas
Updated FDevIDs Dependency
Updated Translations
Updated modules files to process several missing module types used for bug squishing or going fast
Updated Python Dependencies

Bug Fixes

Fixed a bug on older Python versions which couldn't import updated type annotations

Plugin Developers

modules.p and ships.p are deprecated, and slated for removal in 5.11+!
The openurl() function in ttkHyperlinkLabel has been deprecated, -and slated for removal in 5.11+! Please migrate to webbrowser.open().

Release 5.10.3

This release contains a bugfix for the shipyard outfitting parsing system and an update to the French translations.

-We now sign our code! This does mean that built EXEs are now slightly modified on our developer's machines. -For information on what this means, and opt-out options, please visit https://github.com/EDCD/EDMarketConnector/wiki/Code-Signing-and-EDMC -

Changes and Enhancements

Updated French Translations

Bug Fixes

Fixed a bug that crashed the outfitting system when encountering armor. (Thanks TCE team for identifying this one!)

Plugin Developers

modules.p and ships.p are deprecated, and slated -for removal in the next major release! Please look for that change coming soon.
Note to plugin developers: The openurl() function in ttkHyperlinkLabel has been deprecated, -and slated for removal in the next major release! Please migrate to webbrowser.open().

- -

Release 5.10.2

This release contains updated dependencies, some bug fixes, a few minor enhancements to some supporting files, -and some resorted resources as well as a new image for some of the built EXEs.

- -We now sign our code! This does mean that built EXEs are now slightly modified on our developer's machines. -For information on what this means, and opt-out options, please visit https://github.com/EDCD/EDMarketConnector/wiki/Code-Signing-and-EDMC -

Changes and Enhancements

Added additional logging to the Python build string in the case of missing files
Added a new icon to EDMC's Command-Line EXE
Added additional logging to the build system
Updated several dependencies
Updated FDEV IDs
Updated relevant copyright dates
Updated automatic build script to support code signing workflow
Updated translations to the latest versions
Moved a few unused files to the resources folder. These files have no references in the code

Bug Fixes

Fixed a bug that could cause EDMC to handle SIGINT signals improperly
Fixed a bug that could result in URL providers to be set to invalid values
Fixed a bug that could result in Coriolis URL providers to revert back to "Auto" on language translations
Fixed a bug where Inara didn't understand being blown up by a Thargoid, and blew itself up instead
Fixed a printing issue for the localization system for unused strings

Removed Files

Removed two unused manifest and MacOS icon files which are no longer in use.

Known Issues

Some users of TCE have reported issues with newer versions of EDMC with TCE.
- We have been unable to replicate this issue. If you are able to assist, please -add your information here: https://github.com/EDCD/EDMarketConnector/issues/2176
-

Plugin Developers

modules.p and ships.p are deprecated, and slated -for removal in the next major release! Please look for that change coming soon.
Note to plugin developers: The openurl() function in ttkHyperlinkLabel has been deprecated, -and slated for removal in the next major release! Please migrate to webbrowser.open().

- -

Release 5.10.1

This release contains a number of bugfixes, minor performance enhancements, workflow and dependency updates, and a function deprecation.

-Note to plugin developers: modules.p and ships.p are deprecated, and slated for removal in the next major release! Please look for that change coming soon. -Note to plugin developers: The openurl() function in ttkHyperlinkLabel has been deprecated, and slated for removal in the next major release! Please migrate to webbrowser.open(). - -

Changes and Enhancements

Deprecated `openurl()`. Please migrate to `webbrowser.open()`
Updated a number of list comparisons to use more efficient tuple comparisons
Updated a few type hints
Updated a few binary comparitors to be more efficient
Moved `resources.json` and `modules.json` back to the top level for all users
Updated several dependencies
Updated Python version to 3.11.7

Bug Fixes

Fixed an issue where resources files could be in different locations for different users.
- These files are now in the same location (top level) for all users on all distributions.
-
Fixed an issue where CMDRs without the Git application installed would crash on start if running from Source.
- Thanks to the Flatpak team for pointing this one out!
-
Fixed a bug where CMDRs running from source would have their git hash version displayed as UNKNOWN.
- We're now more failure tolerant and use the bundled .gitversion if no true git hash is provided.
-
Fixed a bug where starting two copies of EDMC with a valid install would not generate a duplicate warning.

- -

Release 5.10.0

This release contains a number of under-the-hood changes to EDMC designed to improve performance, code maintainability, and stability of the EDMC application, while providing new features and quality-of-life fixes.

-Note to plugin developers: modules.p and ships.p are deprecated, and slated for removal in the next major release! Please look for that change coming soon. - -

Changes and Enhancements

Added new modules.json and ships.json files to improve security and readability
Added a core Spansh URL provider plugin
Added a new auth response page for successful FDEV authentication
Added a new Open Log Folder option to the Help menu
Added a new --start_min command flag to force the application to start minimized
Added a new pop-up if plugins fail to load or are not supported
Updated commodities and module files to the latest versions
Updated core EDMC and core Plugin menus to a standardized layout
Updates the Inara URL formats to the new endpoints

Bug Fixes

Fixed an issue where indentation of text strings in certain settings windows under various languages -would be unevenly indented
Fixed an issue where the Plugins Folder label in the Plugins settings window would cut off the -selection box for the plugin storage location

Code Clean Up

Added future annotation imports to help with code compatibility
Added a few conditional checks on input processing
Simplified some RegEx expressions, complex functions, logic flows, and Import statements
Simplified the WinSparkle GitHub Build Action
Began to change single-character variables to more descriptive names
Moved a number of global variables into their requisite classes
Updated a number of dependencies to the latest versions
Updated GitHub Actions to the latest versions
Updated a number of resource-allocating functions to use more efficient closing logic
Updated some calls to arrays to be more efficient
Removed a number of old-style typing hints in favor of PEP 585 style hints
Removed a number of redundant if - return - else or raise - else statements for code readability
Removed some default parameter assignments
Removed some obsolete calls to Object

Plugin Developers

modules.p and ships.p have been deprecated, and will be removed in 6.0. -If you are using these files, please update to use the new modules.json and ships.json files instead.
A new method of standardizing the paddings used in settings panels has been applied to the core settings panels. -We strongly encourage you to follow these style hints! A proper guide will be added to the wiki.

+ ]]> +

Release 4.2.3

+ body { font-family:"Segoe UI","Tahoma"; font-size: 75%; } h2 { font-family:"Segoe UI","Tahoma"; font-size: 105%; } -

Release 5.8.0

This release is essentially the same as 5.8.0-rc3 with only the version and -this changelog updated.

It brings a new feature related to Fleetcarrier data, some convenience for -Linux users, some fixes, and otherwise some internal changes that should not -adversely affect either users or third-party plugins. For the latter, read -below for some new/changed things that could benefit you.

-
This release, and all future ones, now create two additional archive files -in the GitHub release:
-
1. EDMarketConnector-release-.zip
2. EDMarketConnector-release-.tar.gz
-
The advantage of these over the GitHub auto-generated ones is that they -have been hand-crafted to contain all the necessary files, and only -those files.
-
If you use the application from source, and not via a git clone, then we -highly recommend you use one of these archives, not the GitHub -auto-generated ones.
-
Anyone installing on Windows should continue to use the -EDMarketConnector_win_.msi files as before.
-
-
New Feature - You can now have the application query the /fleetcarrier -CAPI endpoint for data about your Fleet Carrier. The data will then be -passed to interested plugins.
-
Note that there are some caveats:
-
1. -
  This feature defaults to Off. The option is on the Configuration tab -of Settings as "Enable Fleetcarrier CAPI Queries". It is advised to only -enable this if you know you utilise plugins that make use of the data.
  -
2. -
  These queries are only triggered by CarrierBuy and CarrierStats -Journal events, i.e. upon buying a Fleetcarrier or opening the Carrier -Management UI in-game. NB: There is a 15 minute cooldown between -queries.
  -
3. -
  If you have Fleetcarrier cargo which got into the cargo hold through a lot -of individual transactions, or if you have a lot of separate buy/sell -orders then these queries can take a long time to complete.
  -
  If this happens with your game account then all other CAPI queries will -be blocked until the /fleetcarrier query completes. 'Other CAPI -queries' means those usually triggered upon docking to gather station -market, shipyard and outfitting data. To ameliorate the effects of this -there is currently a timeout of 60 seconds on /fleetcarrier queries, -and will not occur more often than every 15 minutes.
  -
  We plan to address this by moving the /fleetcarrier queries into their -own separate thread in the future.
  -
-
-
The code for choosing the 'Output' folder is now simply the tkinter -function for such a dialogue, rather than a special case on Windows. In -the past the former had issues with Unicode characters, but in testing no -such issue was observed (on a supported OS).
-
-
There are two new items on the "Help" menu:
-
1. Troubleshooting -> Wiki:Troubleshooting -
2. Report A Bug -> Issues - New Bug Report -
-
-
Translations have been updated. Thanks again to our volunteer translators!
-
-
If we ever activate any functionality killswitches, the popup denoting which -are active has been made more readable.
-
-
There's a new section in Contributing.md - "Python Environment". This -should aid any new developers in getting things set up.
-

Linux Users

We now ship an io.edcd.EDMarketConnector.desktop file. To make use of this -you should run scripts/linux-setup.sh once. This will:

-
Check that you have $HOME/bin in your PATH. If not, it will abort.
-
-
Create a shell script edmarketconnector in $HOME/bin to launch the -application.
-
NB: This relies on the filesystem location you placed the source in not -changing. So if you move the source you will need to re-run the script.
-
-
Copy the .desktop and .icon files into appropriate locations. The .desktop -file utilises the shell script created in step 2, and thus relies on it -existing and on it being in a directory that is in your PATH.
-

Once this has been completed any XDG-compliant desktops should have an entry -for "E:D Market Connector" in their "Games" menu.

Fixes

-
The tracking of a Cmdr's location that was being performed by the core EDDN -plugin has been moved into the Journal monitoring code. This results in -the tracking being correct upon application (re)start, reflecting the state -from the latest Journal file, rather than only picking up with any -subsequent new Journal events.
-
This change should remove instances of "Wrong System! Missed Jump ?" and -similar sanity-check "errors" when continuing to play after a user restarts -the application whilst the game is running.
-
Plugin developers, see below for how this change can positively affect you.
-
-
The name of the files written by "File" > "Save Raw Data" now have a . -between the system and station names.
-
-
Use of CAPI data in EDMC.exe when invoked with either -s or -n -arguments hadn't been updated for prior changes, causing such invocations to -fail. This has been fixed.
-

Plugin Developers

-
Each plugin is now handed its own sub-frame as the parent parameter passed -to plugin_app() instead of the actual main UI frame. These new Frames -are placed in the position that plugin UI would have gone into. This should -have no side effects on well-behaved plugins.
-
However, if you have code that attempts to do things like parent.children() -or the like in your plugin_app() implementation, this might have stopped -working. You shouldn't be trying to do anything with any of the UI outside -your plugin anyway, but if you definitely have a need then look things up -using .nametowidget(). There are examples in the core plugins (which DO -have good reason, due to maintaining main UI label values).
-
All of the plugins listed on our Wiki were given perfunctory testing and no -issues from this change were observed.
-
This is a necessary first step to some pending plugin/UI work:
-
-
-
New - capi_fleetcarrier() function to receive the data from a CAPI -/fleetcarrier query. See PLUGINS.md for details.
-
-
It was found that the ShutDown event (note the capitalisation, this is -distinct from the actual Journal Shutdown event) synthesized for plugins -when it is detected that the game has exited was never actually being -delivered. Instead this was erroneously replaced with a synthesized StartUp -event. This has been fixed.
-
-
As the location tracking has been moved out of the core EDDN plugin, and into -monitor.py all of it is now available as members of the state dictionary -which is passed to journal_entry().
-
This both means that no plugin should need to perform such location state -tracking itself and they can take advantage of it being fully up to date -when a user restarts the application with the game running.
-
A reminder: When performing 'catch up' on the newest Journal file found at -startup, the application does not pass any events to the -journal_entry() method in plugins. This is to avoid spamming with -data/state that has possibly already been handled, and in the case of the -Cmdr moving around will end up not being relevant by the time the end of the -file is reached. This limitation was also why the core EDDN plugin couldn't -properly initiate its location tracking state in this scenario.
-
See PLUGINS.md for details of the new state members. Pay particular -attention to the footnote that details the caveats around Body tracking.
-
Careful testing has been done for only the following. So, if you make use -of any of the other new state values and spot a bug, please report it:
-
1. SystemName
2. SystemAddress
3. Body (Name)
4. BodyID
5. BodyType
6. StationName
7. StationType
8. (Station) MarketID
-
-
There is an additional property request_cmdr on CAPIData objects, which -records the name of the Cmdr the request was made for.
-
-
FDevIDs files are their latest versions at time of this version's build.
-
-
examples\plugintest - dropped the "pre-5.0.0 config" code, as it's long -since irrelevant.
-

Developers

Release 4.2.3

This release mostly addresses an issue when Frontier Authorisation gets stuck +on 'Logging in...' despite completing the authorisation on the Frontier +website.

-
If you utilise a git clone of the source code, you should also ensure the -sub-modules are initialised and synchronised. -wiki:Running from source -has been updated to include the necessary commands.
-
-
The coriolis-data git sub-module now uses an HTTPS, not "git" URL, so won't -require authentication for a simple git pull.
-
-
If you have a dump directory in CWD when running EDMarketConnector.py under -a debugger you will get files in that location when CAPI queries complete. -This will now include files with names of the form -FleetCarrier...json for /fleetcarrier data.
+
Allow edmc... argument to EDMarketConnector.exe. This should only be +necessary when something has prevented your web browser from invoking the +edmc protocol via DDE.
+
If you were encountering the 'Logging in...' issue and still do with this +release then please try running the application via the new +EDMarketConnector - localserver-auth.bat file in the installation +directory.
+
This simply runs EDMarketConnector.exe with the +--force-localserver-for-auth command-line argument. This forces the code +to setup and use a webserver on a random port on localhost for the +Frontier Authorisation callback, the same way it already works on +non-Windows platforms.
-
All the main UI tk widgets are now properly named. This might make things -easier if debugging UI widgets as you'll no longer see a bunch of !label1, -!frame1 and the like.
-
Each plugin's separator is named as per the scheme plugin_hr_, and when -a plugin has UI its new container Frame is named plugin_X. Both of these -start with 1, not 0.
+
Add Korean translation to both the application and the installer.

Release 5.7.0

This release re-enables CAPI queries for Legacy players. As a result, the -'Update' button functionality is now restored for Legacy players, along with -"Automatically update on docking" functionality.

-
We now test against, and package with, Python 3.11.1, 32-bit.
-
-
This release is functionally identical to 5.7.0-rc1, as no problems were -reported with that.
-
-
As noted above, Legacy players now have CAPI functionality once more. -Plugin developers check below for how you can determine the source galaxy -of such data.
-
-
Due to a bug it turned out that a workaround for "old browsers don't support -very long URLs" had been inactive since late 2019. As no-one has noticed -or complained we've now removed the defunct code in favour of the simple -webbrowser.open().
-
Testing showed that all of Firefox, Chrome and Chrome-based Edge worked with -very long URLs without issues.
-
-
EDMC.exe -n had been broken for a while, it now functions once more.
-
-
Some output related to detecting and parsing gameversion from Journals -has been moved from INFO to DEBUG. This returns the output of any EDMC.exe -command to the former, quieter, version.
-

Bugs

-
A corner case of "game not running" and "user presses 'Update' button" would -result in an empty uploaderID string being sent to EDDN. Such messages are -still accepted by the EDDN Gateway, and the Relay then obfuscates this field -anyway. So, at worse, this would make it look like the same uploader was in -lots of different places. This has been fixed.
-
-
The message about converting legacy replay.jsonl was being emitted even -when there was no file to convert. This has been fixed.
-

Plugin Developers

Release 4.2.2

This release contains a minor bug-fix, actually properly checking a station's +ships list before operating on it.

-
An erroneous statement about "all of Python stdlib" in PLUGINS.md has been -corrected. We don't/can't easily include all of this. Ask if any part of it -you require is missing.
-
-
In order to not pass Legacy data to plugins without them being aware of it -there is now a new function cmdr_data_legacy(), which mirrors the -functionality of cmdr_data(), but for Legacy data only. See PLUGINS.md -for more details.
-
-
The data passed to cmdr_data() and cmdr_data_legacy() is now correctly -typed as CAPIData. This is a sub-class of UserDict, so you can continue -to use it as such. However, it also has one extra property, source_host, -which can be used to determine if the data was from the Live or Legacy -CAPI endpoint host. See PLUGINS.md for more details.
-
-
If any plugin had been attempting to make use of config.get_int('theme'), -then be aware that we've finally moved from hard-coded values to actual -defined constants. Example use would be as in:
-
```
from config import config
-from theme import theme
-
-active_theme = config.get_int('theme')
-if active_theme == theme.THEME_DARK:
-    ...
-elif active_theme == theme.THEME_TRANSPARENT:
-    ...
-elif active_theme == theme.THEME_DEFAULT:
-    ...
-else:
-    ...
```
-
But remember that all tkinter widgets in plugins will inherit the main UI -current theme colours anyway.
-
-
The contents of NavRoute.json will now be loaded during 'catch-up' when -EDMarketConnector is (re-)started. The synthetic StartUp (note the -capitalisation) event that is emitted after the catch-up ends will have -state['NavRoute'] containing this data.
-
However, the Fileheader event from detecting a subsequent new Journal file -will blank this data again. Thus, if you're interested in "last plotted -route" on startup you should react to the StartUp event. Also, note that -the contents will indicate a NavRouteClear if that was the last such -event.
-
PLUGINS.md has been updated to reflect this.
-
-
If you've ever been in the habit of running our develop branch, please -don't. Whilst we try to ensure that any code merged into this branch doesn't -contain bugs, it hasn't at that point undergone more thorough testing. -Please use the stable branch unless otherwise directed.
-
-
Some small updates have been made in edmc_data as a part of reviewing the -latest update to coriolis-data. -We make no guarantee about keeping these parts of edmc_data up to date. -Any plugins attempting to use that data should look at alternatives, such -as FDevIDs/outfitting.csv.
-
A future update might remove those maps, or at least fully deprecate their -use by plugins. Please contact us now if you actually make use of this -data.
-
Check that ships['shipuard_list'] is a dict before trying to use +.values() on it. This fixes the issue with seeing list object has no attribute values in the application status line.

- -

Release 5.6.1

This release addresses some minor bugs and annoyances with v5.6.0, especially -for Legacy galaxy players.

In general, at this early stage of the galaxy split, we prefer to continue to -warn Legacy users who have 'send data' options active for sites that only -accept Live data. In the future this might be reviewed and such warnings -removed such that the functionality fails silently. This might be of use -to users who actively play in both galaxies.

Release 4.2.1

This is a bug-fix release.

-
CAPI queries will now only be attempted for Live galaxy players This is -a stop-gap whilst the functionality is implemented for Legacy galaxy players. -Doing so prevents using Live galaxy data whilst playing Legacy galaxy, which -would be increasingly wrong and misleading.
-
1. 'Automatic update on docking' will do nothing for Legacy players.
2. Pressing the 'Update' button whilst playing Legacy will result in a status -line message "CAPI for Legacy not yet supported", and otherwise achieve -nothing. The only function of this button is to query CAPI data and -pass it to plugins, which does not include Inara and EDSM.
3. A Legacy player trying to use "File" > "Status" will get the message -"Status: No CAPI data yet" due to depending on CAPI data.
-
It is hoped to implement CAPI data retrieval and use for Legacy players soon, -although this will likely entail extending the plugins API to include a new -function specifically for this. Thus only updated plugins would support -this.
+
Updated translations. Thanks once again to all those contributing as per +Translations.
-
EDDN: Where data has been sourced from the CAPI this application now sends -a header->gameversion in the format "CAPI-(Live|Legacy)- as per -the updated documentation.
- - -As this version only queries CAPI for Live players that will only be -"CAPI-Live-" for the time being. +PLUGINS.md: Clarify when CargoJSON is populated. -If, somehow, the CAPI host queried matches neither the -current Live host, the Legacy host, nor the past beta host, you will see -"CAPI-UNKNOWN-". +macOS: pip install -r requirements.txt will now include pyobjc so that +running this application works at all. Check the updated Running from +source +for some advice if attempting to run on macOS. -As that statement implies, this application will also signal 'Live' if -pts-companion.orerve.net has been used, due to detecting an alpha or beta -version of the game. However, in that case the /test schemas will be used. - - -Closes #1734. +JournalLock: Handle when the Journal directory isn't set at all, rather than +erroring. Fixes #910 - Not launching (Linux).


 
-Inara: Only warn about Legacy data if sending is enabled in Settings > Inara.
-Closes #1730.
+Extra logging added to track down cause of #909 - Authentication not possible (PC)
+. The debug log file might now indicate what's wrong, or we might need
+you to run
+"c:\Program Files (x86)\EDMarketConnector/EDMarketConnector.exe" --trace
+
+in order to increase the log level and gather some extra information.
+Caution is advised if sharing a --trace log file as it will now contain
+some of the actual auth data returned from Frontier.
 
 
-Inara: Handling of some events has had a sanity check added so that the
-Inara API doesn't complain about empty strings being sent.  In these cases
-the event will simply not be sent.
-Closes #1732.
+Ensure that 'Save Raw Data' will work.  Fixes #908 - Raw export of CAPI data broken.
 
 
-EDSM: EDSM has decided to accept only Live data on its API.  Thus, this
-application will only attempt to send data for Live galaxy players.
-If a Legacy galaxy player has the Settings > EDSM > "Send flight log and
-Cmdr status to EDSM" option active then they will receive an error about
-this at most once every 5 minutes.  Disabling that option will prevent the
-warning.
+Prevent EDDN plugin from erroring when we determine if the commander has
+Horizons.  Fixes #907 - Modules is a list not a dict on damaged stations


-Plugin Developers
-
-PLUGINS.md has been updated to make it clear that the only use of imports
-from the config module are for setting/getting/removing a plugin's own
-configuration, or detecting application shutdown in progress.
-PLUGINS.md has also been updated to add a note about how the data passed
-to a plugin cmdr_data() is, strictly speaking, an instance of CAPIData,
-which is an extension of UserDict.  It has some extra properties on it,
-but these are for internal use only and no plugin should rely on them.
-As noted above, implementing CAPI data for Legacy players will likely entail
-an additional function in the API provided to plugins.  See
-#1728 for discussion
-about this.
-
-
 
 
-Release 5.6.0
-Tha major reason for this release is to address the Live versus Legacy galaxy
-split coming in Update 14 of the game.
-See the section "Update 14 and the Galaxy Split" below for how this might
-impact you.
-Changes
-
-
-We now test against, and package with, Python 3.10.8.
-
-
-The code for sending data to EDDN has been reworked.  This changes the
-'replay log' from utilising an internal array, backed by a flat file
-(replay.jsonl), to an sqlite3 database.
-As a result:
-
-Any messages stored in the old replay.jsonl are converted at startup,
-if that file is present, and then the file removed.
-All new messages are stored in this new sqlite3 queue before any attempt
-is made to send them.  An immediate attempt is then made to send any
-message not affected by "Delay sending until docked".
-Sending of queued messages will be attempted every 5 minutes, unless
-"Delay sending until docked" is active and the Cmdr is not docked in
-their own ship.  This is in case a message failed to send due to an issue
-communicating with the EDDN Gateway.
-When you dock in your own ship an immediate attempt to send all queued
-messages will be initiated.
-When processing queued messages the same 0.4-second inter-message delay
-as with the old code has been implemented.  This serves to not suddenly
-flood the EDDN Gateway.  If any message fails to send for Gateway reasons,
-i.e. not a bad message, then this processing is abandoned to wait for
-the next invocation.
-
-The 5-minute timer in point 3 differs from the old code, where almost any
-new message sending attempt could initiate processing of the queue.  At
-application startup this delay is only 10 seconds.
-Currently, the feedback of "Sending data to EDDN..." in the UI status line
-has been removed.
-If you do not have "Delay sending until docked" active, then the only
-messages that will be at all delayed will be where there was a communication
-problem with the EDDN Gateway, or it otherwise indicated a problem other
-than 'your message is bad'.
-
-
-As a result of this EDDN rework this application now sends appropriate
-gameversion and gamebuild strings in EDDN message headers.
-The rework was necessary in order to enable this, in case of any queued
-or delayed messages which did not contain this information in the legacy
-replay.jsonl format.
-
-
-For EDSM there is a very unlikely set of circumstances that could, in theory
-lead to some events not being sent.  This is so as to safeguard against
-sending a batch with a gameversion/build claimed that does not match for
-all of the events in that batch.
-It would take a combination of "communications with EDSM are slow", more
-events (the ones that would be lost), a game client crash, and starting
-a new game client before the 'more events' are sent.
-
-
-Update 14 and the Galaxy Split
-Due to the galaxy split announced by Frontier
-there are some changes to the major third-party websites and tools.
-
-
-Inara has chosen
-to only accept Live galaxy data on its API.
-This application will not even process Journal data for Inara after
-2022-11-29T09:00:00+00:00 unless the gameversion indicates a Live client.
-This explicitly checks that the game's version is semantically equal to or
-greater than '4.0.0'.
-If a Live client is not detected, then there is an INFO level logging
-message "Inara only accepts Live galaxy data", which is also set as the main
-UI status line.  This message will repeat, at most, every 5 minutes.
-If you continue to play in the Legacy galaxy only then you probably want to
-just disable the Inara plugin with the checkbox on Settings > Inara.
-
-
-All batches of events sent to EDSM will be tagged with a gameversion, in
-a similar manner to the EDDN header.
-Ref: EDSM api-journal-v1
-
-
-All EDDN messages will now have appropriate gameversion and gamebuild
-fields in the header as per
-EDDN/docs/Developers.md.
-As a result of this you can expect third-party sites to choose to filter data
-based on that.
-Look for announcements by individual sites/tools as to what they have chosen
-to do.
-
-
-Known Bugs
-In testing if it had been broken at all due to 5.5.0 -> 5.6.0 changes it has
-come to light that EDMC.EXE -n, to send data to EDDN, was already broken in
-5.5.0.
-In addition, there is now some extra 'INFO' logging output which will be
-produced by any invocation of EDMC.EXE.  This might break third-party use of
-it, e.g. Trade Computer Extension Mk.II.
-This will be fixed as soon as the dust settles from Update 14, with emphasis
-being on ensuring the GUI EDMarketConnector.exe functions properly.
-Notes for EDDN Listeners
-
-
-Where EDMC sourced data from the Journal files it will set gameversion
-and gamebuild as per their values in Fileheader or LoadGame, whichever
-was more recent (there are some events that occur between these).
-
-
-If any message was already delayed such that it did not
-have the EDDN header recorded, then the gameversion and gamebuild will
-be empty strings.  In order to indicate this the softwareName will have
- (legacy replay) appended to it, e.g. E:D Market Connector Connector [Windows] (legacy replay).  In general this indicates that the message was
-queued up using a version of EDMC prior to this one.  If you're only
-interested in Live galaxy data then you might want to ignore such messages.
-
-
-Where EDMC sourced data from a CAPI endpoint, the resulting EDDN message
-will have a gameversion of CAPI- set, e.g. CAPI-market.
-At this time it is not 100% certain which galaxy this data will be for, so
-all listeners are advised to ignore/queue such data until this is clarified.
-gamebuild will be an empty string for all CAPI-sourced data.
-
-
-Plugin Developers
-
-There is a new flag in state passed to plugins, IsDocked.  See PLUGINS.md
-for details.
-
-
-
-Release 5.5.0
-
-Virus Total scan results for this release.
-We now test against, and package with, Python 3.10.7.
-EDDN: Support added for the FCMaterials schemas to aid third-party sites in
-offering searches for where to buy and sell Odyssey Micro Resources,
-including on Fleet Carriers with the bar tender facility.
-
-Bug Fixes
-
-EDDN: Abort fsssignaldiscovered sending of message if no signals passed
-the checks.
-EDDN: Add Horizons check for location on fsssignaldiscovered messages.
-Don't alert the user if the first attempted load of NavRoute.json contains
-no route.
-Inara: Don't set marketID for ApproachSettlement unless it's actually
-present in the event.
-
-Plugin Developers
+Release 4.2.0
+This release increases the Minor version due to the major change in how
+multiple-instance checking is done.
 
 
-We now build using the new, setuptools mediated py2exe freeze() method,
-so we're in the clear for when distutils is removed in Python 3.12.
-This shouldn't have any adverse effects on plugins, i.e. all of the same
-Python modules are still packaged as before.
-
-
-Support has been added for the NavRouteClear event.  We do send this
-through to plugins, so that they know the player has cleared the route,
-but we keep the previously plotted route details in state['NavRoute'].
-
-
-The documentation of the return type of journal_entry() has been corrected
-to Optional[str].
+Adds Steam and Epic to the list of "audiences" in the Frontier Auth callout
+so that you can authorise using those accounts, rather than their associated
+Frontier Account details.
 
 
-FDevIDs files (commodity.csv rare_commodity.csv) updated to latest
-versions.
+New status message "CAPI: No commander data returned" if a /profile
+request has no commander in the returned data.  This can happen if you
+literally haven't yet created a Commander on the account.  Previously you'd
+get a confusing 'commander' message shown.
 
-
-Developers
-
-We now build using the new, setuptools mediated py2exe freeze() method,
-so we're in the clear for when distutils is removed in Python 3.12.
-The old setup.py file, along with associated py2exe.cmd have been removed
-in favour of the new Build-exe-and-msi.py file.  Documentation updated.
-
-
-
-Release 5.4.1
-
 
-If for any reason EDMarketConnector.exe fails to shutdown and exit when
-asked to by the upgrade process this should no longer result in a spontaneous
-system reboot.  Closes #1492.
-A manual reboot will still be required to complete the EDMarketConnector
-upgrade process and we make no guarantees about the stability of the
-application until this is done.
+Changes the "is there another process already running?" check to be based on
+a lockfile in the configured Journals directory.  The name of this file is
+edmc-journal-lock.txt and upon successful locking it will contain text
+like:
+Path: 
+PID: 
+
+The lock will be released and applied to the new directory if you change it
+via Settings > Configuration.  If the new location is already locked you'll
+get a 'Retry/Ignore?' pop-up.
+For most users things will operate no differently, although note that the
+multiple instance check does now apply to platforms other than Windows.
+For anyone wanting to run multiple instances of the program this is now
+possible via:
+runas /user: "\"c:\Program Files (x86)\EDMarketConnector\EDMarketConnector.exe\" --force-localserver-for-auth"
+If anything has messed with the backslash characters there then know that you
+need to have " (double-quote) around the entire command (path to program .exe
+and any extra arguments), and as a result need to place a backslash before
+any double-quote characters in the command (such as around the space-including
+path to the program).
+I've verified it renders correctly on GitHub.
+The old check was based solely on there being a window present with the title
+we expect.  This prevented using runas /user:SOMEUSER ... to run a second
+copy of the application, as the resulting window would still be within the
+same desktop environment and thus be found in the check.
+The new method does assume that the Journals directory is writable by the
+user we're running as.  This might not be true in the case of sharing the
+file system to another host in a read-only manner.  If we fail to open the
+lock file read-write then the application aborts the checks and will simply
+continue running as normal.
+Note that any single instance of EDMarketConnector.exe will still only monitor
+and act upon the latest Journal file in the configured location.  If you run
+Elite Dangerous for another Commander then the application will want to start
+monitoring that separate Commander.  See wiki:Troubleshooting#i-run-two-instances-of-ed-simultaneously-but-i-cant-run-two-instances-of-edmc
+which will be updated when this change is in a full release.
 
 
-The new EDDN fsssignaldiscovered/1 schema has been implemented.
+Adds the command-line argument --force-localserver-for-auth. This forces
+using a local webserver for the Frontier Auth callback.  This should be used
+when running multiple instances of the application for all instances
+else there's no guarantee of the edmc:// protocol callback reaching the
+correct process and Frontier Auth will fail.
 
 
-EDSM trace level logging will no longer log API credentials unless explicitly
-asked to, separately from other EDSM API trace logging.
+Adds the command-line argument --suppress-dupe-process-popup to exit
+without showing the warning popup in the case that EDMarketConnector found
+another process already running.
+This can be useful if wanting to blindly run both EDMC and the game from a
+batch file or similar.
 
 
-
-Bug Fixes
-
-EDDN: Ensure we always remove all _Localised suffix keys in data.  This
-was missed in some recent new schemas and turned out to be an issue for at
-least approachsettlement/1.
-
-
-
-Release 5.4.0
-
-We now test against, and package with, Python 3.10.4.
-New EDDN schema fssbodysignals is now supported.
-Odyssey Update 12 will add BodyID to CodexEntry journal events, so don't
-overwrite this with an augmentation if it is already present.  We've also
-added the same for BodyName in case Frontier ever add that.
-
-Translations updated.
-Thanks again to all the contributors.
-
-
-Bug Fixes
-
-Cross-check the MarketID in CAPI data, not only the station name, to ensure
-the data is for the correct station.  Closes #1572.
-Location cross-check paranoia added to several EDDN message types to ensure
-no bad data is sent.
-Ensure we don't send bad BodyID/Name for an orbital station if the player
-uses a taxi.
-Closes #1522.
-
-
-Developers
-
-Odyssey Update 12 adds a new Journal event, and file, FCMaterials.json,
-detailing the available trades at a Fleet Carrier's bar tender.  Support has
-been added for this.  Plugin developers are sent an FCMaterials event
-with the full contents of the file.
-
-
-EDMC.exe
-This now uses specific exit codes in all cases, rather than a generic
-EXIT_SYS_ERR (6) for some cases.  See the appropriate line in EDMC.py for
-details.
-
-
-Release 5.3.4
-Whilst EDMarketConnector.exe was fixed for the Odyssey Update 11 difference in Journal file names, EDMC.exe was not.   If you're wondering, that's the command-line utility that, for instance, Trade Computer Extensions uses to obtain data.
-
-Use the new common function for finding latest journal file in EDMC.py.
-Quietens some NavRoute related logging for the benefit of EDMC.py.  This is
-now at DEBUG level, rather than INFO.
-
-
-
-Release 5.3.3
-Unfortunately 5.3.2 failed to fully address the issues caused by the different
-Journal filenames when using the Odyssey Update 11 client.  It's fine if you
-run EDMarketConnector first and then the game, as the code path that detects
-a new file always does just that.
-But the code for EDMarketConnector startup to find the current newest Journal
-file relied on sorting the filenames and that would mean the new-style names
-would always sort as 'oldest'.
-This release fixes that code to properly use the file modification timestamp
-to determine the newest file on startup.
-
 
-Release 5.3.2
-This release contains one change to cope with how Frontier decided to name
-the Journal files differently in the Update 11 Odyssey client.
-
-
-Release 5.3.1
-This release addresses some issues with newer EDDN code which could cause    erroneous alerts to the player, or sending of bad messages.
                                                                                                                                                                         EDDN: Cope with ApproachSettlement on login occurring before Location,
-such that we don't yet know the name of the star system the player is in.
   Closes #1484
-
                                                                                                                                                       EDDN: Cope with ApproachSettlement missing planetary coordinates on login
-at/near a settlement in Horizons.
                                           Closes #1476
-
                                                                                                                                                       EDDN: Change the CodexEntry "empty string" checks to only apply to those
-values where the schema enforces "must be at least one character".
          This prevents the big 'CodexEntry had empty string, PLEASE ALERT THE EDMC    DEVELOPERS' message from triggering on, e.g. NearestDestination being
-empty, which the schema allows.
                                             Closes #1481
-
                                                                           
                                                                                                                                                       Plugin Developers
-                                                                            
-If you use a sub-class for a widget the core code will no longer break if
-your code raises an exception.  e.g. a plugin was failing due to Python
-3.10 using collections.abc instead of collections, and the plugin's
-custom widget had a configure() method which was called by the core
-theme code on startup or theme change.  This then caused the whole
-application UI to never show up on startup.
-This also applies if you set up a button such that enter/leave on it, i.e.
-mouse in/out, causes the theme.py code for that to trigger.
-So, now in such cases the main UI should actually show up, although your
-plugin's UI might look weird due to theming not being properly applied.
-The plugin exception WILL be logged, at ERROR level.
-
-
 
 
-Release 5.3.0
-As has sadly become routine now, please read
-our statement about malware false positives
-affecting our installers and/or the files they contain.  We are as confident
-as we can be, without detailed auditing of python.org's releases and all
-the py2exe source and releases, that there is no malware in the files we make
-available.
-This release is primarily aimed at fixing some more egregious bugs,
-shortcomings and annoyances with the application.  It also adds support for
-two additional
-EDDN
-schemas.
+Release 4.1.6
+We might have finally found the cause of the application hangs during shutdown.
+Note that this became easier to track down due to the downtime
+for migration of www.edsm.net around 2021-01-11.  Before these fixes EDSM's
+API not being available would cause an EDMC hang on shutdown.
 
 
-We now test and build using Python 3.10.2.  We do not yet make use of any
-features specific to Python 3.10 (or 3.9).  Let us restate that we
-absolutely reserve the right to commence doing so.
+We've applied extra paranoia to some of the application shutdown code to
+ensure we're not still trying to handle journal events during this sequence.
+We also re-ordered the shutdown sequence, which might help avoid the shutdown
+hang.
+If you encounter a shutdown hang then please add a comment and log files to
+Application can leave a zombie process on shutdown #678
+to help us track down the cause and fix it.
 
 
-We now set a custom User-Agent header in all web requests, i.e. to EDDN,
-EDSM and the like.  This is of the form:
-EDCD-EDMarketConnector-
+We now avoid making Tk event_generate() calls whilst the appliction is
+shutting down.
 
 
-"File" -> "Status" will now show the new Odyssey ranks, both the new
-categories and the new 'prestige' ranks, e.g. 'Elite I'.
-NB: Due to an oversight there are currently no translations for these.
-Closes #1369.
+Plugins should actively avoid making any sort of Tk event_generate() call
+during application shutdown.
+This means using if not config.shutting_down: to gate any code in worker
+threads that might attempt this.  Also, be sure you're not attempting such
+in your plugin_stop() function.
+See plugins/edsm.py and plugins/inara.py for example of the usage.
 
 
-Running EDMarketConnector.exe --reset-ui will now also reset any changes to
-the application "UI Scale" or geometry (position and size).
-Closes #1155.
+Any use of plug.show_error() won't actually change the UI status line
+during shutdown, but the text you tried to show will be logged instead.
 
 
-We now use UTC-based timestamps in the application's log files.  Prior to
-this change it was the "local time", but without any indication of the
-applied timezone.  Each line's timestamp has  UTC as a suffix now.  We
-are assuming that your local clock is correct and the timezone is set
-correctly, such that Python's time.gmtime() yields UTC times.
-This should make it easier to correlate application logfiles with in-game
-time and/or third-party service timestamps.
+Cargo tracking will now correctly count all instances of the same type of
+cargo for different missions.  Previously it only counted the cargo for
+the last mission requiring that cargo type, as found in Cargo.json.
 
 
-The process used to build the Windows installers should now always pick up
-all the necessary files automatically.  Prior to this we used a manual
-process to update the installer configuration which was prone to both user
-error and neglecting to update it as necessary.
+The loaded contents of Cargo.json can now be found in monitor.state['CargoJSON'].
+monitor.state is what is passed to plugins as state in the
+journal_entry() call.
 
 
-If the application fails to load valid data from the NavRoute.json file
-when processing a Journal NavRoute event, it will attempt to retry this
-operation a number of times as it processes subsequent Journal events.
-This should hopefully work around a race condition where the game might
-not have yet updated NavRoute.json at all, or has truncated it to empty,
-when we first attempt this.
-We will also now NOT attempt to load NavRoute.json during the startup
-'Journal catch-up' mode, which only sets internal state.
-Closes #1348.
+Our logging code should now cope with logging from a property.
 
 
-Inara: Use the ->Statistics->Bank_Account->Current_Wealth
-value when sending a setCommanderCredits message to Inara to set
-commanderAssets.
-In addition, a setCommanderCredits message at game login will now only
-ever be sent at game login.  Yes, you will NEED to relog to send an
-updated balance.  This is the only way in which to sanely keep the
-'Total Assets' value on Inara from bouncing around.
-Refer to Inara:API:docs:setCommanderCredits.
-Closes #1401.
+Logging from any name-mangled method should now work properly.
 
 
-Inara: Send a setCommanderRankPilot message when the player logs in to the
-game on-foot.  Previously you would HAVE to be in a ship at login time
-for this to be sent.
-Thus, you can now relog on-foot in order to update Inara with any Rank up
-or progress since the session started.
-Closes #1378.
-
-
-Inara: Fix for always sending a Rank Progress of 0%.
-Closes #1378.
-
-
-Inara: You should once more see updates for any materials used in
-Engineering.  The bug was in our more general Journal event processing
-code pertaining to EngineerCraft events, such that the state passed to
-the Inara plugin hadn't been updated.
-Such updates should happen 'immediately', but take into account that there
-can be a delay of up to 35 seconds for any data sent to Inara, due to how
-we avoid breaking the "2 messages a minute" limit on the Inara API.
-Closes #1395.
-
-
-EDDN: Implement new approachsettlement/1
-schema.
-
-
-EDDN: Implement new fssallbodiesfound/1
-schema.
-
-
-EDDN: We now compress all outgoing messages.  This might help get some
-particularly large navroute messages go through.
-If any message is now rejected as 'too large' we will drop it, and thus
-not retry it later.  The application logs will reflect this.
-NB: The EDDN Gateway was updated to allow messages up to 1 MiB in size
-anyway.  The old limit was 100 KiB.
-Closes #1390.
-
-
-EDDN: In an attempt to diagnose some errors observed on the EDDN Gateway
-with respect to messages sent from this application some additional checks
-and logging have been added.
-NB: After some thorough investigation it was concluded that these EDDN
-errors were likely the result of long-delayed messages due to use of
-the "Delay sending until docked" option.
-There should be no functional changes for users.  But if you see any of
-the following in this application's log files PLEASE OPEN
-AN ISSUE ON GITHUB
-with all the requested information, so that we can correct the relevant
-code:
-
-No system name in entry, and system_name was not set either!  entry: ...
-BodyName was present but not a string! ...
-post-processing entry contains entry ...
-this.body_id was not set properly: ...
-system is falsey, can't add StarSystem
-this.coordinates is falsey, can't add StarPos
-this.systemaddress is falsey, can't add SystemAddress
-this.status_body_name was not set properly: ...
-
-You might also see any of the following in the application status text
-(bottom of the window):
-
-passed-in system_name is empty, can't add System
-CodexEntry had empty string, PLEASE ALERT THE EDMC DEVELOPERS
-system is falsey, can't add StarSystem
-this.coordinates is falsey, can't add StarPos
-this.systemaddress is falsey, can't add SystemAddress
-
-Ref: #1403
-#1393.
-
-
-
-Translations
-
-
-Use a different workaround for OneSky (translations website) using "zh-Hans"
-for Chinese (Simplified), whereas Windows will call this "zh-CN". This is
-in-code and documented with a comment, as opposed to some 'magic' in the
-Windows Installer configuration that had no such documentation. It's less
-fragile than relying on that, or developers using a script/documented
-process to rename the file.
-
-
-As noted above we forgot to upload to
-OneSky
-after adding the Odyssey new ranks/categories.  This has now been done,
-and some new phrases await translation.
+Miscellaneous updates to PLUGINS.md - mostly to clarify some things.
 
 
 
-Release 5.2.4
-This is a very minor update that simply imports the latest versions of
-data files so that some niche functionality works properly.
-
-
-Update commodity.csv and rare_commodity.csv from the latest
-EDCD/FDevIDs versions.  This addresses
-an issue with export of market data in Trade Dangerous format containing
-OnionHeadC rather than the correct name, Onionhead Gamma Strain, that
-Trade Dangerous is expecting.
-This will only have affected Trade Dangerous users who use EDMarketConnector
-as a source of market data.
-
-
-
+				]]>
+