Skip to content

Port --custom_artifacts_path from iLEAPP for loader parity #939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abrignoni merged 1 commit into from
Jul 8, 2026
Merged

Port --custom_artifacts_path from iLEAPP for loader parity #939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions aleapp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@
import traceback
import sys

import pathlib
import scripts.plugin_loader as plugin_loader
import leapp_functions.app.history as history

from scripts.search_files import *
from scripts.ilapfuncs import *
from scripts.search_files import * # pylint: disable=wildcard-import,unused-wildcard-import
from scripts.ilapfuncs import * # pylint: disable=wildcard-import,unused-wildcard-import
from scripts.version_info import leapp_name, leapp_version
from time import process_time, gmtime, strftime, perf_counter
from scripts.lavafuncs import *
from scripts.lavafuncs import * # pylint: disable=wildcard-import,unused-wildcard-import
from scripts.context import Context

def validate_args(args):
Expand Down Expand Up @@ -152,9 +153,8 @@ def main():
help=("Generate a text file list of artifact paths. "
"This argument is meant to be used alone, without any other arguments."))
parser.add_argument('--custom_output_folder', required=False, action="store", help="Custom name for the output folder")
parser.add_argument('--custom_artifacts_path', required=False, action="store", help="Additional path to load artifacts from (e.g., scripts/alternate_artifacts)")

loader = plugin_loader.PluginLoader()
available_plugins = list(loader.plugins)
profile_filename = None
casedata = {}

Expand All @@ -165,6 +165,12 @@ def main():

args = parser.parse_args()

loader_paths = [plugin_loader.PLUGINPATH]
if args.custom_artifacts_path:
loader_paths.append(pathlib.Path(args.custom_artifacts_path))
loader = plugin_loader.PluginLoader(plugin_paths=loader_paths)
available_plugins = list(loader.plugins)

plugins = []
plugins_parsed_first = []

Expand All @@ -184,13 +190,13 @@ def main():
if args.artifact_paths:
print('Artifact path list generation started.')
print('')
with open('path_list.txt', 'a') as paths:
with open('path_list.txt', 'a', encoding='utf-8') as paths:
for plugin in loader.plugins:
if isinstance(plugin.search, tuple):
for x in plugin.search:
paths.write(x + '\n')
print(x)
else: # TODO check that this is actually a string?
else: # search should be a string here
paths.write(plugin.search + '\n')
print(plugin.search)
print('')
Expand Down Expand Up @@ -231,7 +237,7 @@ def main():
with open(case_data_filename, "rt", encoding="utf-8") as case_data_file:
try:
case_data = json.load(case_data_file)
except:
except: # pylint: disable=bare-except
case_data_load_error = "File was not a valid case data file: invalid format"
print(case_data_load_error)
return
Expand All @@ -256,7 +262,7 @@ def main():
with open(profile_filename, "rt", encoding="utf-8") as profile_file:
try:
profile = json.load(profile_file)
except:
except: # pylint: disable=bare-except
profile_load_error = "File was not a valid case data file: invalid format"
print(profile_load_error)
return
Expand Down Expand Up @@ -332,7 +338,7 @@ def crunch_artifacts(
else:
logfunc('Error on argument -o (input type)')
return False
except Exception as ex:
except Exception: # pylint: disable=broad-exception-caught
logfunc('Had an exception in Seeker - see details below. Terminating Program!')
temp_file = io.StringIO()
traceback.print_exc(file=temp_file)
Expand Down Expand Up @@ -387,7 +393,7 @@ def crunch_artifacts(
lava_insert_sqlite_file_path(file_path_id,seeker.file_infos.get(pathh).source_path)
file_path_ids.add(file_path_id)
lava_insert_sqlite_artifact_link_pattern_to_file(artifact_search_pattern_id, file_path_id)
log.write(f'</li></ul>')
log.write('</li></ul>')
files_found.extend(found)
if files_found:
category_folder = os.path.join(out_params.output_folder_base, '_HTML', plugin.category)
Expand All @@ -400,13 +406,13 @@ def crunch_artifacts(
continue # cannot do work
try:
plugin.method(files_found, category_folder, seeker, wrap_text)
except Exception as ex:
except Exception as ex: # pylint: disable=broad-exception-caught
logfunc('Reading {} artifact had errors!'.format(plugin.name))
logfunc('Error was {}'.format(str(ex)))
logfunc('Exception Traceback: {}'.format(traceback.format_exc()))
continue # nope
else:
logfunc(f"No file found")
logfunc("No file found")
logfunc('{} [{}] artifact completed'.format(plugin.name, plugin.module_name))
parsed_modules += 1
GuiWindow.SetProgressBar(parsed_modules, len(plugins))
Expand Down
125 changes: 110 additions & 15 deletions scripts/plugin_loader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,109 @@
"""
Plugin loader module for dynamically loading and managing artifact plugins.

Provides functionality to discover and load modules from the artifacts directory.
It supports both v1 and v2 artifact formats and manages theit metadata through
the PluginSpec dataclass.

Classes:
PluginSpec: A frozen dataclass containing artifact metadata including name, module name,
category, search paths, callable method, and artifact information.
PluginLoader: Main class for loading and managing artifacts. Discovers Python files in
the artifacts directory, extracts artifact definitions, and provides access
to loaded artifacts.

Constants:
PLUGINPATH: Default path to the artifacts directory, resolved relative to this file's
location for PyInstaller compatibility.

"""

import pathlib
import dataclasses
import typing
import importlib.util

#PLUGINPATH = pathlib.Path("./scripts/artifacts")
# PLUGINPATH = pathlib.Path("./scripts/artifacts")
# a bit long-winded to make compatible with PyInstaller
PLUGINPATH = pathlib.Path(__file__).resolve().parent / pathlib.Path("artifacts")


@dataclasses.dataclass(frozen=True)
class PluginSpec:
"""
Specification class for artifact metadata and configuration.
This class stores essential information about an artifact including its identification,
categorization, search criteria, execution method, and details.
Attributes:
name (str): The name of the artifact.
module_name (str): The Python module name where the artifact is defined.
category (str): The category this artifact belongs to.
search (str): Search pattern used to identify relevant files.
method (Callable): The callable function that executes the artifact's main logic.
artifact_info (dict): Dictionary containing metadata and information about artifacts.
"""

name: str
module_name: str
category: str
search: str
method: typing.Callable # todo define callable signature
method: typing.Callable # to do: define callable signature
artifact_info: dict # Add this line to include artifact_info


class PluginLoader:
def __init__(self, plugin_path: typing.Optional[pathlib.Path] = None):
self._plugin_path = plugin_path or PLUGINPATH
"""
A class responsible for dynamically loading and managing artifacts from Python files.
The PluginLoader scans a specified directory for Python files containing artifact definitions
and loads them lazily. It supports two versions of artifact definitions:
- Version 2 (__artifacts_v2__): Dictionary-based with detailed metadata
- Version 1 (__artifacts__): Tuple-based (category, search, func)
Attributes:
_plugin_path (pathlib.Path): The directory path containing LEAPPs module.
_plugins (dict[str, PluginSpec]): Dictionary mapping artifact names to their specifications.
Args:
plugin_path (typing.Optional[pathlib.Path]): Optional path to LEAPPs module directory.
If not provided, defaults to PLUGINPATH.
Raises:
KeyError: If duplicate function names are found across different modules.
"""

def __init__(self, plugin_paths: typing.Optional[typing.List[pathlib.Path]] = None):
self._plugin_paths = plugin_paths or [PLUGINPATH]
self._plugins: dict[str, PluginSpec] = {}
self._load_plugins()
self._artifact_names = {}
self._plugin_sources = {}
for path in self._plugin_paths:
self._load_plugins(path)

@staticmethod
def load_module_lazy(path: pathlib.Path):
spec = importlib.util.spec_from_file_location(path.stem, path)
"""
Lazily loads a Python module from a file path.
This function creates a module specification from the given file path and uses
LazyLoader to defer the execution of the module until its attributes are accessed.
This can improve startup performance when loading many plugins.
Args:
path (pathlib.Path): The file path to the Python module to be loaded.
The module name will be derived from the file stem (filename without extension).
Returns:
module: The loaded module object. The module's code is executed lazily upon
first attribute access.
"""

# Use the full module path to avoid name collisions between different plugin directories
module_name = f"{path.parent.name}.{path.stem}"
spec = importlib.util.spec_from_file_location(module_name, path)
loader = importlib.util.LazyLoader(spec.loader)
spec.loader = loader
mod = importlib.util.module_from_spec(spec)
loader.exec_module(mod)
return mod

def _load_plugins(self):
for py_file in self._plugin_path.glob("*.py"):
def _load_plugins(self, plugin_path: pathlib.Path):
for py_file in plugin_path.glob("*.py"):
if py_file.name == "__init__.py":
continue
mod = PluginLoader.load_module_lazy(py_file)
mod_artifacts = getattr(mod, '__artifacts_v2__', None) or getattr(mod, '__artifacts__', None)
if mod_artifacts is None:
Expand All @@ -46,21 +115,21 @@ def _load_plugins(self):
if version == 2:
category = artifact.get('category')
search = artifact.get('paths')

artifact_name = artifact.get('name')
func = None
# 1. Look for a wrapped function with the name of the dictionary
for item_name in dir(mod):
item = getattr(mod, item_name)
if callable(item) and item_name == name and hasattr(item, '__wrapped__'):
func = item
break

# 2. If no wrapped function, look for declared function
if func is None:
func_name = artifact.get('function')
if func_name:
func = getattr(mod, func_name, None)

# 3. If neither above work, log the failure
if func is None:
print(f"Warning: No matching function found for artifact '{name}' in module '{py_file.stem}'")
Expand All @@ -73,18 +142,45 @@ def _load_plugins(self):

else:
# 4. If no v2, then use v1
artifact_name = name
category, search, func = artifact
artifact_info = {'category': category, 'paths': search}

# Check for duplicate plugin keys within the same artifact folder and error
# Identify duplicate plugin in alternate plugin folder and override standard
if name in self._plugins:
raise KeyError(f"Duplicate plugin: '{name}' in module '{py_file.stem}'")

prev_path = self._plugin_sources[name]
if prev_path == plugin_path:
raise KeyError(f"Duplicate plugin key: '{name}' in module '{py_file.stem}'")
else:
print(f"Info: Overriding artifact key '{name}' from {prev_path.name} "
f"with version from {plugin_path.name}/{py_file.name}")

# Check for duplicate artifact names within the same artifact folder
if artifact_name in self._artifact_names:
prev_file, prev_path = self._artifact_names[artifact_name]
if prev_path == plugin_path:
raise KeyError(f"Duplicate artifact name in {py_file.name}: "
f"'{artifact_name}' was also found in module '{prev_file}'")

self._artifact_names[artifact_name] = (py_file.name, plugin_path)
self._plugin_sources[name] = plugin_path

# Add artifact_info to PluginSpec
self._plugins[name] = PluginSpec(name, py_file.stem, category, search, func, artifact_info)


@property
def plugins(self) -> typing.Iterable[PluginSpec]:
"""
Yields all loaded artifacts specifications.
This method provides an iterable access to all artifacts that have been
loaded and stored in the internal _plugins dictionary.
Yields
------
PluginSpec
Individual plugin specification objects from the internal plugins collection.
"""

yield from self._plugins.values()

def __getitem__(self, item: str) -> PluginSpec:
Expand All @@ -95,4 +191,3 @@ def __contains__(self, item):

def __len__(self):
return len(self._plugins)

Loading