Warnings on Campaign Load

[IllianiCBT]

Requires: MegaMek/megamek#6414

• Added a warning that requests the user complete all active contracts when updating to a new client version.
• This warning is triggered if the campaign being saved was last saved in an older version and has an active contract.
• Active contracts are defined as any contract which has already started, or has been accepted but not yet started (i.e. the user is still en route to the contract).
• The warning does not stop the campaign from loading, to ensure we can still load older saves when investigating bugs and what have you.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 10.33%. Comparing base (b602ee8) to head (edd5b66).
Report is 2 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #5757      +/-   ##
============================================
- Coverage     10.33%   10.33%   -0.01%     
- Complexity     6124     6127       +3     
============================================
  Files          1036     1037       +1     
  Lines        138533   138592      +59     
  Branches      20482    20495      +13     
============================================
- Hits          14321    14318       -3     
- Misses       122824   122884      +60     
- Partials       1388     1390       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[IllianiCBT]

• Updated to include feedback from Luana

[Scoppio]

My suggestion would be something like the following, but inside the CampaignFactory file, with the CampaignXMLParser returning a container with the campaign and the relevant diagnostics:

Somewhere add this:

    // Somewhere
    public enum CampaignProblemType {
        NONE,
        ACTIVE_CONTRACT,
        ACTIVE_FUTURE_CONTRACT,
        CANT_LOAD_FROM_VERSION,
        CANT_PARSE_FILE,
    }

    public record ParsedCampaign(Campaign campaign, String currentMekHQVersion, String fileMekHQVersion, CampaignProblemType problem, String diagnostics) { 
    public boolean hasProblems() {
            return problem != null;
        }
    }

In the CampaignFactory

    public ParsedCampaign createCampaign(InputStream is)
        throws CampaignXmlParseException, IOException, NullEntityException {
        if (!is.markSupported()) {
            is = new BufferedInputStream(is);
        }

        byte[] header = readHeader(is);

        // Check if the first two bytes are the GZIP magic bytes...
        if ((header.length >= 2) && (header[0] == (byte) 0x1f) && (header[1] == (byte) 0x8b)) {
            is = new GZIPInputStream(is);
        }
        // ...otherwise, assume we're an XML file.

        CampaignXmlParser parser = new CampaignXmlParser(is, this.app);
        ParsedCampaign parsedCampaign = parser.parse();
        return parsedCampaign;
    }

This way, the place that receives the file will be able to handle it accordingly.

DataLoadingDialog.java

                // And then load the campaign object from it.
                try (FileInputStream fis = new FileInputStream(getCampaignFile())) {
                    ParsedCampaign parsedCampaign = CampaignFactory.newInstance(getApplication()).createCampaign(fis);
                    if (parsedCampaign.hasProblems()) {
                        // TODO: CALL ERROR HANDLING FUNCTION FOR EACH POSSIBLE PROBLEM
                    }
                    campaign.restore();
                    campaign.cleanUp();
                }
                // endregion Progress 6

Otherwise we keep with the problem where we have being imported stuff inserted inside a parser class.

Sorry for not being clear the first time.

[Scoppio]

The "parse()" and the diagnostics can run in two different steps, this way not disrupting any tests or old files and just adding new functionality.

[IllianiCBT]

So I had to wait until my brain had the cycles to process this, but now that it does what you're saying makes perfect sense and will be super maintainable. I would have never thought to use Enums like this. Thanks for the feedback! :)

[IllianiCBT]

• incorporated Luana's suggestions