Log event parser

.gitignore

@@ -1,7 +1,8 @@
 # PyCharm
-
 .idea/
 .vscode/
+working/
+.vbump.ini
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -15,6 +16,8 @@ __pycache__/
 
 # Distribution / packaging
 .Python
+.venv/
+.nparse.venv/
 env/
 venv/
 bin/
@@ -65,3 +68,4 @@ docs/_build/
 wiki/
 old/
 nparse.config.json
+

Makefile

@@ -0,0 +1,58 @@
+
+PACKAGE=nparse
+
+##############################################################################
+# do this while not in venv
+venv:
+	python -m venv .$(PACKAGE).venv
+
+venv.clean:
+	rm -rfd .$(PACKAGE).venv
+
+
+
+##############################################################################
+# do these while in venv
+run: libs.quiet
+	py $(PACKAGE).py
+
+
+# libs make targets ###########################
+libs: requirements.txt
+	pip install -r requirements.txt
+
+libs.quiet: requirements.txt
+	pip install -q -r requirements.txt
+
+libs.clean:
+	pip uninstall -r requirements.txt
+
+
+# exe make targets ###########################
+exe: libs
+	pyinstaller nparse_py.spec
+
+exe.clean:
+	rm -rfd build
+	rm dist/$(PACKAGE).exe
+
+
+# install make targets ###########################
+#DIRS=dist/data dist/xxx
+DIRS=dist/data dist/data/maps dist/data/spells
+install: exe
+	$(shell mkdir $(DIRS))
+	cp -r ./data/maps/* ./dist/data/maps/
+	cp -r ./data/spells/* ./dist/data/spells/
+
+install.clean:
+	rm -rfd $(DIRS)
+
+
+# general make targets ###########################
+
+all: libs exe install
+
+all.clean: libs.clean exe.clean install.clean
+
+clean: all.clean

data/maps/map_files/Crystal_1.txt

@@ -1,4 +1,4 @@
-P -298.0000, 184.0000, 0.0000,  127, 64, 0,  2,  Bank
+P -298.0000, 192.0000, -384,  127, 64, 0,  2,  Bank
 P -758.0000, 265.0000, 0.0000,  127, 64, 0,  2,  Broken_Bridge
 P 939.1472, 589.2308, -538.4664,  127, 0, 0,  2,  Queen
 P -692.0000, 176.0000, 0.0000,  127, 64, 0,  2,  Waterfall

helpers/__init__.py

@@ -5,7 +5,13 @@
 import sys
 
 import requests
+import json
+
+import psutil
+
+from datetime import datetime, timedelta
 
+from .parser import Parser  # noqa: F401
 from .parser import ParserWindow  # noqa: F401
 
 
@@ -100,3 +106,31 @@ def text_time_to_seconds(text_time):
         pass
 
     return timedelta(hours=hours, minutes=minutes, seconds=seconds).total_seconds()
+
+
+def get_eqgame_pid_list() -> list[int]:
+    """
+    get list of process ID's for eqgame.exe, using psutil module
+
+    Returns:
+        object: list of process ID's (in case multiple versions of eqgame.exe are somehow running)
+    """
+
+    pid_list = list()
+    for p in psutil.process_iter(['name']):
+        if p.info['name'] == 'eqgame.exe':
+            pid_list.append(p.pid)
+    return pid_list
+
+
+def starprint(line: str) -> None:
+    """
+    utility function to print with leading and trailing ** indicators
+
+    Args:
+        line: text to be printed
+
+    Returns:
+        None:
+    """
+    print(f'** {line.rstrip():<100} **')

helpers/config.py

@@ -5,8 +5,10 @@
 from glob import glob
 import json
 
+# global data
 data = {}
-_filename = ''
+_filename: str = ''
+char_name: str = ''
 APP_EXIT = False
 
 
@@ -285,6 +287,30 @@ def verify_settings():
         False
     )
 
+    # deathloopvaccine
+    data['deathloopvaccine'] = data.get('deathloopvaccine', {})
+    data['deathloopvaccine']['toggled'] = get_setting(
+        data['deathloopvaccine'].get('toggled', True),
+        True
+        )
+    data['deathloopvaccine']['deaths'] = get_setting(
+        data['deathloopvaccine'].get('deaths', 4),
+        4
+        )
+    data['deathloopvaccine']['seconds'] = get_setting(
+        data['deathloopvaccine'].get('seconds', 120),
+        120
+        )
+
+    # logeventparser
+    # todo - replace this general LogEventParser.toggled setting, with one for each LogEvent type
+    section_name = 'LogEventParser'
+    data[section_name] = data.get(section_name, {})
+    data[section_name]['toggled'] = get_setting(
+        data[section_name].get('toggled', True),
+        True
+        )
+
 
 def get_setting(setting, default, func=None):
     try:

helpers/logreader.py

@@ -1,12 +1,17 @@
 import os
 import datetime
 from glob import glob
+from typing import Optional
 
 from PyQt6.QtCore import QFileSystemWatcher, pyqtSignal
 
 from helpers import config
 from helpers import location_service
 from helpers import strip_timestamp
+import parsers
+
+# pointer to the LogEventParser object, so this code can update the character name when the logfile changes
+theLogEventParser: Optional[parsers.LogEventParser] = None
 
 
 class LogReader(QFileSystemWatcher):
@@ -45,9 +50,12 @@ def _file_changed_safe_wrap(self, changed_file):
     def _file_changed(self, changed_file):
         if changed_file != self._stats['log_file']:
             self._stats['log_file'] = changed_file
-            char_name = os.path.basename(changed_file).split("_")[1]
+            config.char_name = os.path.basename(changed_file).split("_")[1]
+            # use the global pointer to update the charname
+            if theLogEventParser:
+                theLogEventParser.set_char_name(config.char_name)
             if not config.data['sharing']['player_name_override']:
-                config.data['sharing']['player_name'] = char_name
+                config.data['sharing']['player_name'] = config.char_name
                 location_service.SIGNALS.config_updated.emit()
             with open(self._stats['log_file'], 'rb') as log:
                 log.seek(0, os.SEEK_END)

helpers/parser.py

@@ -3,9 +3,54 @@
                              QPushButton, QVBoxLayout, QWidget)
 
 from helpers import config
+from datetime import datetime
 
 
-class ParserWindow(QFrame):
+class Parser:
+
+    def __init__(self):
+        super().__init__()
+        self.name = 'Parser'    # could this be self.__class__.__name__ instead?
+        self._visible = False
+
+    def isVisible(self) -> bool:
+        return self._visible
+
+    def hide(self):
+        self._visible = False
+
+    def show(self):
+        self._visible = True
+
+    # main parsing logic here - derived classed should override this to perform their particular parsing tasks
+    def parse(self, timestamp: datetime, text: str) -> None:
+
+        # default behavior = simply print passed info
+        # this strftime mask will recreate the EQ log file timestamp format
+        line = f'[{timestamp.strftime("%a %b %d %H:%M:%S %Y")}] ' + text
+        print(f'[{self.name}]:{line}')
+
+    def toggle(self, _=None) -> None:
+        if self.isVisible():
+            self.hide()
+            config.data[self.name]['toggled'] = False
+        else:
+            self.set_flags()
+            self.show()
+            config.data[self.name]['toggled'] = True
+        config.save()
+
+    def shutdown(self) -> None:
+        pass
+
+    def set_flags(self) -> None:
+        pass
+
+    def settings_updated(self) -> None:
+        pass
+
+
+class ParserWindow(QFrame, Parser):
 
     def __init__(self):
         super().__init__()
@@ -90,16 +135,6 @@ def _toggle_frame(self):
     def set_title(self, title):
         self._title.setText(title)
 
-    def toggle(self, _=None):
-        if self.isVisible():
-            self.hide()
-            config.data[self.name]['toggled'] = False
-        else:
-            self.set_flags()
-            self.show()
-            config.data[self.name]['toggled'] = True
-        config.save()
-
     def closeEvent(self, _):
         if config.APP_EXIT:
             return
@@ -124,9 +159,3 @@ def enterEvent(self, event):
     def leaveEvent(self, event):
         self._menu.setVisible(False)
         QFrame.leaveEvent(self, event)
-
-    def shutdown(self):
-        pass
-
-    def settings_updated(self):
-        pass

nparse.py

@@ -28,7 +28,7 @@
     config.data['general']['qt_scale_factor'] / 100)
 
 
-CURRENT_VERSION = '0.6.6-rc1'
+CURRENT_VERSION = '0.6.6-rc1-rlog14'
 if config.data['general']['update_check']:
     ONLINE_VERSION = get_version()
 else:
@@ -75,12 +75,20 @@ def _load_parsers(self):
             "maps": parsers.Maps(),
             "spells": parsers.Spells(),
             "discord": parsers.Discord(),
+            "deathloopvaccine": parsers.DeathLoopVaccine(),
+            "LogEventParser": parsers.LogEventParser(),
         }
         self._parsers = [
             self._parsers_dict["maps"],
             self._parsers_dict["spells"],
             self._parsers_dict["discord"],
+            self._parsers_dict["deathloopvaccine"],
+            self._parsers_dict["LogEventParser"],
         ]
+
+        # save a pointer to the LogEventParser so the logreader can update the char name when needed
+        logreader.theLogEventParser = self._parsers_dict['LogEventParser']
+
         for parser in self._parsers:
             if parser.name in config.data.keys() and 'geometry' in config.data[parser.name].keys():
                 g = config.data[parser.name]['geometry']
@@ -193,11 +201,12 @@ def _menu(self, event):
 
             # save parser geometry
             for parser in self._parsers:
-                g = parser.geometry()
-                config.data[parser.name]['geometry'] = [
-                    g.x(), g.y(), g.width(), g.height()
-                ]
-            config.save()
+                if parser.name in config.data.keys() and 'geometry' in config.data[parser.name].keys():
+                    g = parser.geometry()
+                    config.data[parser.name]['geometry'] = [
+                        g.x(), g.y(), g.width(), g.height()
+                    ]
+                config.save()
 
             self._system_tray.setVisible(False)
             config.APP_EXIT = True