load.py

import sys
import os
from typing import Optional, List, Tuple, Dict, Any, Union
import logging
import functools
import itertools
import json

import tkinter as tk
import myNotebook
from ttkHyperlinkLabel import HyperlinkLabel
from config import config, appname

import edmfs
import edmfat_web_services

this = sys.modules[__name__]
this.plugin_name = "Minor Faction Activity Tracker"
this.minor_factions = tk.StringVar()
this.activity_summary = tk.StringVar()
this.current_station = ""
this.version = (0, 31, 0)
this.logger = logging.getLogger(f'{appname}.{os.path.basename(os.path.dirname(__file__))}')
this.settings_file = os.path.join(os.path.dirname(sys.modules[__name__].__file__), "settings.json")
this.star_system_resolver = functools.partial(edmfat_web_services.resolve_star_system_via_edsm, this.logger)
this.get_last_market = functools.partial(edmfat_web_services.get_last_market, this.logger)
this.serializer = edmfs.TrackerFileRepository()

CONFIG_MINOR_FACTION = "edmfat_minor_faction"
DEFAULT_MINOR_FACTIONS = {"EDA Kunti League"}
NO_ACTIVITY = "(No activity)"
NO_MINOR_FACTIONS = "(Select minor faction(s) in the Settings dialog)"


# Called by EDMC on startup
def plugin_start3(plugin_dir: str) -> str:
    load_settings()
    update_activity()
    update_minor_factions()
    return this.plugin_name


# Called by EDMC to show plug-in details on EDMC main window
def plugin_app(parent: tk.Frame) -> Union[tk.Widget, Tuple[tk.Widget, tk.Widget]]:
    REPO_OWNER = "anthonylangsworth"
    REPO = "EDMFAT"
    NEW_RELEASE_AVAILABLE = "New EDMFAT release available"
    BACKGROUND = tk.Label().cget("background")

    frame = tk.Frame(parent)
    frame.columnconfigure(0, weight=1)
    frame.columnconfigure(1, weight=1)
    tk.Label(frame, textvariable=this.minor_factions, wraplength=300, justify=tk.CENTER, anchor=tk.W).grid(row=0, column=0, columnspan=2)
    tk.Button(frame, text="Copy", command=copy_activity_to_clipboard).grid(row=1, column=0, sticky=tk.E, padx=10)
    tk.Button(frame, text="Copy + Reset", command=copy_activity_to_clipboard_and_reset).grid(row=1, column=1, sticky=tk.W, padx=10)
    tk.Label(frame, textvariable=this.activity_summary, anchor=tk.W, justify=tk.LEFT, pady=10).grid(row=2, column=0, columnspan=2, sticky=tk.W)

    try:
        latest_release_url = edmfat_web_services.get_newer_release(this.logger, REPO_OWNER, REPO, this.version)
        if latest_release_url:
            HyperlinkLabel(
                frame, text=NEW_RELEASE_AVAILABLE, background=BACKGROUND, url=latest_release_url, underline=True
            ).grid(row=3, column=0, columnspan=8, sticky=tk.W)
    except Exception as e:
        this.logger.error(f"Error getting latest version from github: {e}")

    return frame


# Called by EDMC to populate preferences dialog
def plugin_prefs(parent: myNotebook.Notebook, cmdr: str, is_beta: bool) -> Optional[tk.Frame]:
    PADX = 10
    PADY = 10
    INSTRUCTIONS = "Track missions and activity for or against minor faction(s). If the desired minor faction does not appear in 'Available Minor Factions', jump to a system where the minor faction is present and reopen this dialog."
    VERSION = f"Version: {'.'.join(map(str, this.version))}"
    URL = "https://github.com/anthonylangsworth/EDMFAT"
    AVAILABLE_LABEL = "Available Minor Factions:"
    TRACKED_LABEL = "Tracked Minor Factions:"
    TRACK_BUTTON_LABEL = "Track >"
    UNTRACK_BUTTON_LABEL = "< Untrack"
    TRACK_ALL_BUTTON_LABEL = "Track All >>"
    UNTRACK_ALL_BUTTON_LABEL = "<< Untrack All"
    # COPY_RAW_BUTTON_LABEL = "Copy Raw Activity"
    MISSION_WARNING = "This plug-in may not record some missions correctly due to Elite: Dangerous limitations."
    MISSION_WARNING_URL = "https://github.com/anthonylangsworth/EDMFAT/blob/master/doc/missions.md"
    SHOW_ANTI_LABEL = "Show ANTI work. Uncheck to declutter activity when working for multiple minor factions in the same star system."
    BACKGROUND = myNotebook.Label().cget("background")
    FOREGROUND = myNotebook.Label().cget("foreground")

    # known_minor_factions = {"EDA Kunti League", "Kunti Dragons", "LTT 2337 Empire Party", "HR 1597 & Co", "The Fuel Rats Mischief", "The Scovereign Justice League", "Hutton Orbital Truckers", "The Dark Wheel", "Edge Fraternity", "Colonia Citizens Network", "Mobius Colonial Republic Navy", "Tenjin Pioneers Colonia", "Knights of Colonial Karma", "Ed's 38"}
    known_minor_factions = set(itertools.chain.from_iterable(star_system.minor_factions for star_system in this.tracker.galaxy_state.systems.values()))
    known_minor_factions.difference_update(this.tracker.minor_factions)
    known_minor_factions = sorted(known_minor_factions)

    frame = myNotebook.Frame(parent)

    HyperlinkLabel(
        frame, text=this.plugin_name, background=BACKGROUND, url=URL, underline=True
    ).grid(row=0, padx=PADX, pady=PADY, sticky=tk.W)
    myNotebook.Label(frame, text=VERSION).grid(row=0, column=3, padx=PADX, sticky=tk.E)

    myNotebook.Label(frame, text=INSTRUCTIONS, wraplength=800, justify=tk.LEFT, anchor=tk.W).grid(row=2, column=0, columnspan=3, padx=PADX, sticky=tk.W)

    myNotebook.Label(frame, text=AVAILABLE_LABEL).grid(row=4, column=0, padx=PADX, pady=(PADY, 0), sticky=tk.W)
    this.available_mf_list = tk.Listbox(frame, selectmode="extended", foreground=FOREGROUND, background=BACKGROUND)
    this.available_mf_list.config(height=8, width=40)
    this.available_mf_list.grid(row=5, column=0, rowspan=4, sticky=tk.W, padx=(PADX, 0))
    this.available_mf_list.insert(tk.END, *known_minor_factions)
    scrollbar = tk.Scrollbar(frame, orient=tk.VERTICAL)
    scrollbar.config(command=this.available_mf_list.yview)
    scrollbar.grid(row=5, column=0, rowspan=4, sticky=tk.NS + tk.E)
    this.available_mf_list.config(yscrollcommand=scrollbar.set)

    tk.Button(frame, text=TRACK_BUTTON_LABEL, command=track_selected_minor_factions).grid(row=5, column=1, sticky=(tk.W, tk.E), padx=PADX)
    tk.Button(frame, text=UNTRACK_BUTTON_LABEL, command=untrack_selected_minor_factions).grid(row=6, column=1, sticky=(tk.W, tk.E), padx=PADX)
    tk.Button(frame, text=TRACK_ALL_BUTTON_LABEL, command=track_all_minor_factions).grid(row=7, column=1, sticky=(tk.W, tk.E), padx=PADX)
    tk.Button(frame, text=UNTRACK_ALL_BUTTON_LABEL, command=untrack_all_minor_factions).grid(row=8, column=1, sticky=(tk.W, tk.E), padx=PADX)

    myNotebook.Label(frame, text=TRACKED_LABEL).grid(row=4, column=2, padx=PADX, pady=(PADY, 0), sticky=tk.W)
    this.tracked_mf_list = tk.Listbox(frame, selectmode="extended", foreground=FOREGROUND, background=BACKGROUND)
    this.tracked_mf_list.config(height=8, width=40)
    this.tracked_mf_list.grid(row=5, column=2, rowspan=4, sticky=tk.W, padx=(PADX, 0))
    this.tracked_mf_list.insert(tk.END, *sorted(this.tracker.minor_factions))
    scrollbar = tk.Scrollbar(frame, orient=tk.VERTICAL)
    scrollbar.config(command=this.tracked_mf_list.yview)
    scrollbar.grid(row=5, column=2, rowspan=4, sticky=tk.NS + tk.E)
    this.tracked_mf_list.config(yscrollcommand=scrollbar.set)

    HyperlinkLabel(
        frame, text=MISSION_WARNING, background=BACKGROUND, url=MISSION_WARNING_URL, underline=True
    ).grid(row=9, column=0, columnspan=3, padx=PADX, pady=PADY, sticky=tk.W)

    this.show_anti = tk.IntVar(value=int(this.tracker.show_anti))
    myNotebook.Checkbutton(
        frame, text=SHOW_ANTI_LABEL, variable=this.show_anti, onvalue=1, offvalue=0
    ).grid(row=10, column=0, columnspan=10, sticky=tk.W, padx=(PADX, 0))

    # Removing for now
    # tk.Button(frame, text=COPY_RAW_BUTTON_LABEL, command=copy_raw_activity).grid(row=10, column=0, sticky=tk.W, padx=PADX)

    return frame


# Called by EMDC when the user presses "OK" on the settings dialog
def prefs_changed(cmdr: str, is_beta: bool) -> None:
    this.tracker.minor_factions = this.tracked_mf_list.get(0, tk.END)
    this.tracker.show_anti = bool(this.show_anti.get())
    update_minor_factions()
    update_activity()
    this.logger.info(f"Minor factions changed to {this.tracker.minor_factions}")
    save_config()


# Called by EDMC when a new entry is written to a journal file
def journal_entry(cmdr: str, is_beta: bool, system: Optional[str], station: Optional[str], entry: Dict[str, Any], state: Dict[str, Any]) -> Optional[str]:
    if not is_beta:
        if this.tracker.on_event(entry):
            this.activity_summary.set(this.tracker.activity)
            save_config()


# Called by EDMC on shutdown
def plugin_stop() -> None:
    save_config()


# Copied from https://stackoverflow.com/questions/579687/how-do-i-copy-a-string-to-the-clipboard/4203897#4203897
def copy_to_clipboard(data: str) -> None:
    root = tk.Tk()
    root.withdraw()
    root.clipboard_clear()
    root.clipboard_append(data)
    root.update()
    root.destroy()


def copy_activity_to_clipboard() -> None:
    copy_to_clipboard(this.tracker.activity)


def copy_activity_to_clipboard_and_reset() -> None:
    copy_activity_to_clipboard()
    this.tracker.clear_activity()
    save_config()
    update_activity()


def copy_raw_activity() -> None:
    copy_to_clipboard(json.dumps([this.serializer._serialize_event_summary_v1(event_summary) for event_summary in this.tracker._event_summaries], sort_keys=True, indent=4))


def track_selected_minor_factions() -> None:
    move_selected_minor_factions(this.available_mf_list, this.tracked_mf_list)


def untrack_selected_minor_factions() -> None:
    move_selected_minor_factions(this.tracked_mf_list, this.available_mf_list)


def move_selected_minor_factions(src: tk.Listbox, dst: tk.Listbox) -> None:
    selected_mf = [src.get(index) for index in src.curselection()]

    src_set = set(src.get(0, tk.END))
    src_set.difference_update(selected_mf)
    src.delete(0, tk.END)
    src.insert(tk.END, *sorted(src_set))

    dst_set = set(dst.get(0, tk.END))
    dst_set.update(selected_mf)
    dst.delete(0, tk.END)
    dst.insert(tk.END, *sorted(dst_set))


def track_all_minor_factions() -> None:
    move_all_minor_factions(this.available_mf_list, this.tracked_mf_list)


def untrack_all_minor_factions() -> None:
    move_all_minor_factions(this.tracked_mf_list, this.available_mf_list)


def move_all_minor_factions(src: tk.Listbox, dst: tk.Listbox) -> None:
    src_mf = src.get(0, tk.END)
    src.delete(0, tk.END)

    dst_set = set(dst.get(0, tk.END))
    dst_set.update(src_mf)
    dst.delete(0, tk.END)
    dst.insert(tk.END, *sorted(dst_set))


def update_activity() -> None:
    if len(this.tracker.activity.strip(" \r\n\t")) > 0:
        this.activity_summary.set(this.tracker.activity)
    else:
        this.activity_summary.set(NO_ACTIVITY)


def update_minor_factions() -> None:
    if len(this.tracker.minor_factions) > 0:
        this.minor_factions.set(", ".join(sorted(this.tracker.minor_factions)))
    else:
        this.minor_factions.set(NO_MINOR_FACTIONS)


def load_settings_from_file() -> edmfs.Tracker:
    tracker = None
    try:
        with open(this.settings_file, "r") as settings_file:
            tracker = this.serializer.deserialize(settings_file.read(), this.logger, this.star_system_resolver, this.get_last_market)
        this.logger.info(f"Loaded settings from \"{this.settings_file}\"")
    except FileNotFoundError:
        this.logger.info(f"Setings file \"{this.settings_file}\" not found. This is expected on the first run.")
        pass
    # except json.decoder.JSONDecodeError:
    except Exception:
        this.logger.exception(f"Error loading settings from \"{this.settings_file}\"")
    return tracker


def load_settings_from_config() -> edmfs.Tracker:
    try:
        saved_minor_factions = config.get_list(CONFIG_MINOR_FACTION)
    except Exception:
        saved_minor_factions = {}
    if saved_minor_factions is None:
        saved_minor_factions = DEFAULT_MINOR_FACTIONS
        this.logger.info(f"Defaulting to minor faction(s): {', '.join(sorted(saved_minor_factions))}")
    else:
        saved_minor_factions = {}
    return edmfs.Tracker(saved_minor_factions, True, this.logger, star_system_resolver=this.star_system_resolver,
        get_last_market=this.get_last_market)


def load_settings() -> List[str]:
    this.tracker = load_settings_from_file()
    if not this.tracker:
        this.tracker = load_settings_from_config()


def save_config() -> None:
    with open(this.settings_file, mode="w") as settings_file:
        settings_file.write(this.serializer.serialize(this.tracker))
    try:
        config.delete(CONFIG_MINOR_FACTION)
    except Exception:
        pass  # Do nothing if the config entry does not exist
    this.logger.info(f"Settings saved to \"{this.settings_file}\"")