load.py

"""
A dummy plugin for testing and illustrative purposes.

It doesn't do anything very useful, but it does implement the plugin interface. It's used to enable unit testing of
the unit test harness making it a test harness test harness.

It could also serve as a template for a new plugin.
It displays journal events as they occur and stores the latest journal, dashboard, and carrier data in global variables for inspection.
"""
import tkinter as tk
from dataclasses import dataclass, field
from typing import Dict

from companion import CAPIData # type: ignore
import myNotebook as nb # type: ignore

from demoplugin.utils.debug import Debug, catch_exceptions
from demoplugin.utils.updater import Updater, Notices, read_version_file
from demoplugin.ui import UI

PLUGIN_NAME = "DemoPlugin"

GH_OWNER = "dwomble" # Github owner name
GH_PROJECT = 'EDMC-DemoPlugin' #  Github project name
GH_MAIN = "main" # Github main branch name

@dataclass
class Plugin:
    name:str = PLUGIN_NAME
    version:str = "0.0.0"
    plugin_dir:str = ""
    updater:Updater|None = None
    notices:Notices|None = None
    frame:tk.Frame|None = None
    ui:UI|None = None
    closing:bool = False

@dataclass
class Dashboard:
    cmdr:str = ""
    is_beta:bool = False
    entry:Dict[str, int] = field(default_factory=dict)
    parent:tk.Frame|None = None
    frame:tk.Frame|None = None

@dataclass
class Journal:
    cmdr:str = ""
    is_beta:bool = False
    system:str = ""
    station:str = ""
    entry:Dict[str, int] = field(default_factory=dict)
    state:Dict[str, int] = field(default_factory=dict)

@dataclass
class Carrier:
    data = None

plugin:Plugin = Plugin()
dashboard:Dashboard = Dashboard()
journal:Journal = Journal()
carrier:Carrier = Carrier()

def get_overlay(modern:bool):
    """ Try loading an overlay plugin. Return True if it was successful, False if not. """
    try:
        from EDMCOverlay import edmcoverlay # type: ignore
        if modern:
            from overlay_plugin.overlay_api import define_plugin_group # type: ignore
        return edmcoverlay.Overlay()
    except ImportError:
        pass
    return None

def plugin_start3(plugin_dir):
    """ Load this plugin into EDMC """
    version = read_version_file(plugin_dir, "0.0.0")

    plugin.version = str(version)
    plugin.plugin_dir = plugin_dir
    plugin.updater = Updater(str(plugin.plugin_dir), GH_OWNER, GH_PROJECT)
    # Let's not since this is a dummy plugin
    #plugin.updater.check_for_update(version)

    plugin.notices = Notices(GH_OWNER, GH_PROJECT, GH_MAIN)
    plugin.notices.check_for_notices()

    return PLUGIN_NAME

def plugin_stop():
    """ EDMC is closing """
    if plugin.updater and plugin.updater.install_update:
        plugin.updater.install(["data"])

    plugin.closing = True

@catch_exceptions
def plugin_app(parent:tk.Frame):
    """ Return a TK Frame for adding to the EDMC main window """
    # An extra unweighted wrapper here would block EDMC's stretch from reaching self.frame's own weighted column
    plugin.ui = UI(parent)
    plugin.frame = plugin.ui.frame

    return plugin.frame

def plugin_prefs(parent:tk.Frame, cmdr:str, is_beta:bool):
    """ Return a TK Frame for adding to the EDMC settings dialog """
    prefs:nb.Frame = nb.Frame(parent)
    return prefs

def prefs_changed(cmdr:str, is_beta:bool) -> None:
    """ Save settings. """
    pass

def journal_entry(cmdr, is_beta, system, station, entry, state):
    """ Parse an incoming journal entry and store the data we need """

    journal.cmdr = cmdr
    journal.is_beta = is_beta
    journal.system = system
    journal.station = station
    journal.entry = entry
    journal.state = state

    if not plugin.ui:
        return

    plugin.ui.add_entry(entry)

def dashboard_entry(cmdr:str, is_beta:bool, entry:dict) -> None:
    """ Handle dashboard state changes """

    dashboard.cmdr = cmdr
    dashboard.is_beta = is_beta
    dashboard.entry = entry

    if plugin.ui:
        plugin.ui.update_dashboard(entry)

def capi_fleetcarrier(data:CAPIData):
    """ Handle Fleet carrier data """

    carrier.data = data