dissect.target 3.9.dev36__py3-none-any.whl → 3.9.dev38__py3-none-any.whl

dissect/target/plugin.py

@@ -13,7 +13,7 @@ import logging
 import os
 import sys
 import traceback
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Callable, Iterator, Optional, Type
 
@@ -811,13 +811,13 @@ class InternalPlugin(Plugin):
         return cls
 
 
-@dataclass
+@dataclass(frozen=True, eq=True)
 class PluginFunction:
     name: str
     output_type: str
     class_object: str
     method_name: str
-    plugin_desc: dict
+    plugin_desc: dict = field(hash=False)
 
 
 def plugin_function_index(target: Target) -> tuple[dict[str, Any], set[str]]:
@@ -831,7 +831,9 @@ def plugin_function_index(target: Target) -> tuple[dict[str, Any], set[str]]:
     rootset = set()
 
     def all_plugins():
-        yield from plugins()
+        # Filter out plugins based on the target os
+        os_type = type(target._os) if target._os else None
+        yield from plugins(os_type)
         yield from os_plugins()
         yield from child_plugins()  # Doesn't export anything but added for completeness.
 
@@ -885,33 +887,34 @@ def find_plugin_functions(target: Target, patterns: str, compatibility: bool = F
             pattern += "*"
 
         if wildcard or treematch:
-            for index_name, func in functions.items():
-                if fnmatch.fnmatch(index_name, pattern):
-                    method_name = index_name.split(".")[-1]
-                    loaded_plugin_object = load(func)
+            for index_name in fnmatch.filter(functions.keys(), pattern):
+                func = functions[index_name]
 
-                    # Skip plugins that don't want to be found by wildcards
-                    if not loaded_plugin_object.__findable__:
-                        continue
+                method_name = index_name.split(".")[-1]
+                loaded_plugin_object = load(func)
+
+                # Skip plugins that don't want to be found by wildcards
+                if not loaded_plugin_object.__findable__:
+                    continue
 
-                    fobject = inspect.getattr_static(loaded_plugin_object, method_name)
+                fobject = inspect.getattr_static(loaded_plugin_object, method_name)
 
-                    if compatibility:
-                        try:
-                            if not loaded_plugin_object(target).is_compatible():
-                                continue
-                        except Exception:
+                if compatibility:
+                    try:
+                        if not loaded_plugin_object(target).is_compatible():
                             continue
+                    except Exception:
+                        continue
 
-                    result.append(
-                        PluginFunction(
-                            name=index_name,
-                            class_object=loaded_plugin_object,
-                            method_name=method_name,
-                            output_type=getattr(fobject, "__output__", "text"),
-                            plugin_desc=func,
-                        )
+                result.append(
+                    PluginFunction(
+                        name=index_name,
+                        class_object=loaded_plugin_object,
+                        method_name=method_name,
+                        output_type=getattr(fobject, "__output__", "text"),
+                        plugin_desc=func,
                     )
+                )
         else:
             # otherwise match using ~ classic style
             if pattern.find(".") > -1:
@@ -920,15 +923,15 @@ def find_plugin_functions(target: Target, patterns: str, compatibility: bool = F
                 funcname = pattern
                 namespace = None
 
-            plugindesc = None
-            for index_name, func in functions.items():
+            plugin_descriptions = []
+            for _, func in functions.items():
                 nsmatch = namespace and func["namespace"] == namespace and funcname in func["exports"]
                 fmatch = not namespace and not func["namespace"] and funcname in func["exports"]
                 if nsmatch or fmatch:
-                    plugindesc = func
+                    plugin_descriptions.append(func)
 
-            if plugindesc:
-                loaded_plugin_object = load(plugindesc)
+            for description in plugin_descriptions:
+                loaded_plugin_object = load(description)
                 fobject = inspect.getattr_static(loaded_plugin_object, funcname)
 
                 if compatibility and not loaded_plugin_object(target).is_compatible():
@@ -936,11 +939,12 @@ def find_plugin_functions(target: Target, patterns: str, compatibility: bool = F
 
                 result.append(
                     PluginFunction(
-                        name=f"{plugindesc['module']}.{pattern}",
+                        name=f"{description['module']}.{pattern}",
                         class_object=loaded_plugin_object,
                         method_name=funcname,
                         output_type=getattr(fobject, "__output__", "text"),
-                        plugin_desc=plugindesc,
+                        plugin_desc=description,
                     )
                 )
-    return result
+
+    return list(set(result))

dissect/target/tools/query.py

@@ -202,10 +202,16 @@ def main():
         basic_entries = []
         yield_entries = []
 
+        # Keep a set of plugins that were already executed on the target.
+        executed_plugins = set()
+
         first_seen_output_type = default_output_type
         cli_params_unparsed = rest
 
-        for func_def in funcs:
+        for func_def in find_plugin_functions(target, args.function, False):
+            if func_def.method_name in executed_plugins:
+                continue
+
             try:
                 output_type, result, cli_params_unparsed = execute_function_on_target(
                     target, func_def, cli_params_unparsed
@@ -213,17 +219,17 @@ def main():
             except UnsupportedPluginError as e:
                 target.log.error(
                     "Unsupported plugin for `%s`: %s",
-                    func,
+                    func_def,
                     e.root_cause_str(),
                 )
 
                 target.log.debug("", exc_info=e)
                 continue
             except PluginNotFoundError:
-                target.log.error("Cannot find plugin `%s`", func)
+                target.log.error("Cannot find plugin `%s`", func_def)
                 continue
             except Exception:
-                target.log.error("Exception while executing function `%s`", func, exc_info=True)
+                target.log.error("Exception while executing function `%s`", func_def, exc_info=True)
                 continue
 
             if first_seen_output_type and output_type != first_seen_output_type:
@@ -236,7 +242,7 @@ def main():
                         "does not match first seen output `%s`."
                     ),
                     output_type,
-                    func,
+                    func_def,
                     first_seen_output_type,
                 )
                 parser.exit()
@@ -244,12 +250,14 @@ def main():
             if not first_seen_output_type:
                 first_seen_output_type = output_type
 
+            executed_plugins.add(func_def.method_name)
+
             if output_type == "record":
                 record_entries.append(result)
             elif output_type == "yield":
                 yield_entries.append(result)
             elif output_type == "none":
-                target.log.info("No result for function `%s` (output type is set to 'none')", func)
+                target.log.info("No result for function `%s` (output type is set to 'none')", func_def)
                 continue
             else:
                 basic_entries.append(result)

dissect/target/tools/utils.py

@@ -3,7 +3,7 @@ import inspect
 import json
 from datetime import datetime
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Optional, Tuple, Type
+from typing import Any, Callable, Dict, Iterator, List, Optional, Tuple, Type, Union
 
 from dissect.target import Target
 from dissect.target.exceptions import UnsupportedPluginError
@@ -129,13 +129,16 @@ def generate_argparse_for_plugin(
     return generate_argparse_for_plugin_class(plugin_instance.__class__, usage_tmpl=usage_tmpl)
 
 
-def plugin_factory(target: Target, plugin_class: type, funcname: str) -> tuple[Plugin, str]:
+def plugin_factory(target: Target, plugin: Union[type, object], funcname: str) -> tuple[Plugin, str]:
     if TargetdLoader.instance:
         return target.get_function(funcname)
+
+    if isinstance(plugin, type):
+        plugin_obj = plugin(target)
+        target_attr = getattr(plugin_obj, funcname)
+        return plugin_obj, target_attr
     else:
-        plugin_obj = plugin_class(target)
-    target_attr = getattr(plugin_obj, funcname)
-    return plugin_obj, target_attr
+        return plugin, getattr(plugin, funcname)
 
 
 def execute_function_on_target(
@@ -149,9 +152,40 @@ def execute_function_on_target(
 
     cli_params = cli_params or []
 
-    plugin_class = func.class_object
+    target_attr = get_target_attribute(target, func)
+    plugin_method, parser = plugin_function_with_argparser(target_attr)
+
+    if parser:
+        parsed_params, cli_params = parser.parse_known_args(cli_params)
+        method_kwargs = vars(parsed_params)
+        value = plugin_method(**method_kwargs)
+    else:
+        value = target_attr
+
+    output_type = getattr(plugin_method, "__output__", "default") if plugin_method else "default"
+    return (output_type, value, cli_params)
+
+
+def get_target_attribute(target: Target, func: PluginFunction) -> Union[Plugin, Callable]:
+    """Retrieves the function attribute from the target.
+
+    If the function does not exist yet, it will attempt to load it into the target.
+
+    Args:
+        target: The target we wish to run the function on.
+        func: The function to run on the target.
 
-    if issubclass(plugin_class, OSPlugin):
+    Returns:
+        The function, either plugin or a callable to execute.
+
+    Raises:
+        UnsupportedPluginError: When the function was incompatible with the target.
+    """
+    plugin_class = func.class_object
+    if target.has_function(func.method_name):
+        # If the function is already attached, use the one inside the target.
+        plugin_class, _ = target.get_function(func.method_name)
+    elif issubclass(plugin_class, OSPlugin):
         # OS plugin does not need to be added
         plugin_class = target._os_plugin
     else:
@@ -162,7 +196,14 @@ def execute_function_on_target(
                 f"Unsupported function `{func.method_name}` for target with plugin {func.class_object}", cause=e
             )
 
-    plugin_obj, target_attr = plugin_factory(target, plugin_class, func.method_name)
+    _, target_attr = plugin_factory(target, plugin_class, func.method_name)
+    return target_attr
+
+
+def plugin_function_with_argparser(
+    target_attr: Union[Plugin, Callable]
+) -> tuple[Optional[Iterator], Optional[argparse.ArgumentParser]]:
+    """Resolves which plugin function to execute, and creates the argument parser for said plugin."""
     plugin_method = None
     parser = None
 
@@ -178,16 +219,7 @@ def execute_function_on_target(
     elif callable(target_attr):
         plugin_method = target_attr
         parser = generate_argparse_for_bound_method(target_attr)
-
-    if parser:
-        parsed_params, cli_params = parser.parse_known_args(cli_params)
-        method_kwargs = vars(parsed_params)
-        value = plugin_method(**method_kwargs)
-    else:
-        value = target_attr
-
-    output_type = getattr(plugin_method, "__output__", "default") if plugin_method else "default"
-    return (output_type, value, cli_params)
+    return plugin_method, parser
 
 
 def persist_execution_report(output_dir: Path, report_data: Dict, timestamp: datetime) -> Path:

{dissect.target-3.9.dev36.dist-info → dissect.target-3.9.dev38.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dissect.target
-Version: 3.9.dev36
+Version: 3.9.dev38
 Summary: This module ties all other Dissect modules together, it provides a programming API and command line tools which allow easy access to various data sources inside disk images or file collections (a.k.a. targets)
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3
@@ -21,7 +21,7 @@ Requires-Dist: dissect.ntfs (<4.0.dev,>=3.4.dev)
 Requires-Dist: dissect.regf (<4.0.dev,>=3.3.dev)
 Requires-Dist: dissect.util (<4.0.dev,>=3.0.dev)
 Requires-Dist: dissect.volume (<4.0.dev,>=3.0.dev)
-Requires-Dist: flow.record (~=3.9)
+Requires-Dist: flow.record (~=3.10)
 Requires-Dist: structlog
 Provides-Extra: full
 Requires-Dist: asn1crypto ; extra == 'full'

{dissect.target-3.9.dev36.dist-info → dissect.target-3.9.dev38.dist-info}/RECORD

@@ -3,7 +3,7 @@ dissect/target/container.py,sha256=R8M9EE7DqKq8DeMuekcpR1nxtZ827zuqmTmO4s7PYkg,7
 dissect/target/exceptions.py,sha256=w3qNa4dtGpxUkOCfmAQtvseQrpQq9qmO9wIbztRlIDQ,2273
 dissect/target/filesystem.py,sha256=YJfuRzd37DIm91cVPlMZK-XjiJ1UCZG93htaYcSUrIk,46276
 dissect/target/loader.py,sha256=_gLb3nTAlyS0MS3JEFFD44Qk7X5MQMfhoRTFWaH7sA4,7072
-dissect/target/plugin.py,sha256=qF0okKg7TxYfiLVxpCWhb18gvDsNtr9nCYD7kSeaYIU,31955
+dissect/target/plugin.py,sha256=GLoCrD1eKMy_tbRkwd8YzkSdPNdym5M0-e-aR8kTt10,32098
 dissect/target/report.py,sha256=06uiP4MbNI8cWMVrC1SasNS-Yg6ptjVjckwj8Yhe0Js,7958
 dissect/target/target.py,sha256=TgDY-yAsReOQOG-Phz_m1vdNucdbk9fUI_RMZpMeYG8,28334
 dissect/target/volume.py,sha256=vHBXdDttpiu-Q_oWycNM7fdJ5N8Ob7-i_UBJK9DEs24,15027
@@ -248,10 +248,10 @@ dissect/target/tools/fs.py,sha256=dz6IEz1CKTVsSuMu6oAqdkc1qfIfqnMGABHSDDKKSDM,36
 dissect/target/tools/info.py,sha256=ZYRKLANt99uhpMcP5eHj6WegWAffqq8tS8MNj5txwqE,5141
 dissect/target/tools/logging.py,sha256=5ZnumtMWLyslxfrUGZ4ntRyf3obOOhmn8SBjKfdLcEg,4174
 dissect/target/tools/mount.py,sha256=gPez-PLaeof7a6s7spJ23F_JcdQ7cUOPx5FX42rqF4A,2500
-dissect/target/tools/query.py,sha256=Btt_PMVAWIYHhPLg0b8u5e_TDdG8CG5xapxLu82dbSE,11466
+dissect/target/tools/query.py,sha256=PHj-lNgcHSOQ401Hlc-HvpupAx4wnQNPeFOrxYyDJg0,11779
 dissect/target/tools/reg.py,sha256=37g_Xdb5ZbYAkMgQFmZNdKM_wWP9Bcw2Kk6quo1gwZ4,2147
 dissect/target/tools/shell.py,sha256=HICeIN5kCZYyGmAm_riWO9xrGnQmOzSp-Oici4QeO6Y,36003
-dissect/target/tools/utils.py,sha256=Et3Z67JKv-zzKLhJ6VWn6oiZ9GLoSt6em3sUxNJjyoc,7191
+dissect/target/tools/utils.py,sha256=yDdQxAlWpwlOSnZlN9-ktreMxG_q-NXY_1Z8f7lnAQI,8446
 dissect/target/tools/dump/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dissect/target/tools/dump/run.py,sha256=yHn9xl_VjasgiuLpjtZdnLW32QCbkwHfnnTPY6Ck_aw,9689
 dissect/target/tools/dump/state.py,sha256=ZBNz4ou2Xk20K1H8R83S1gq6qcqPvPPVAaPWzpKpX34,9123
@@ -261,10 +261,10 @@ dissect/target/volumes/bde.py,sha256=gYGg5yF9MNARwNzEkrEfZmKkxyZW4rhLkpdnPJCbhGk
 dissect/target/volumes/disk.py,sha256=95grSsPt1BLVpKwTclwQYzPFGKTkFFqapIk0RoGWf38,968
 dissect/target/volumes/lvm.py,sha256=_kIB1mdRs1OFhRgoT4VEP5Fv8imQnI7oQ_ie4x710tQ,1814
 dissect/target/volumes/vmfs.py,sha256=mlAJ8278tYaoRjk1u6tFFlCaDQUrVu5ZZE4ikiFvxi8,1707
-dissect.target-3.9.dev36.dist-info/COPYRIGHT,sha256=m-9ih2RVhMiXHI2bf_oNSSgHgkeIvaYRVfKTwFbnJPA,301
-dissect.target-3.9.dev36.dist-info/LICENSE,sha256=DZak_2itbUtvHzD3E7GNUYSRK6jdOJ-GqncQ2weavLA,34523
-dissect.target-3.9.dev36.dist-info/METADATA,sha256=gvoKMDbMeKEx-jaq_u5oxUS4PW4FrDShGItVS8LVTKA,10233
-dissect.target-3.9.dev36.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-dissect.target-3.9.dev36.dist-info/entry_points.txt,sha256=tvFPa-Ap-gakjaPwRc6Fl6mxHzxEZ_arAVU-IUYeo_s,447
-dissect.target-3.9.dev36.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
-dissect.target-3.9.dev36.dist-info/RECORD,,
+dissect.target-3.9.dev38.dist-info/COPYRIGHT,sha256=m-9ih2RVhMiXHI2bf_oNSSgHgkeIvaYRVfKTwFbnJPA,301
+dissect.target-3.9.dev38.dist-info/LICENSE,sha256=DZak_2itbUtvHzD3E7GNUYSRK6jdOJ-GqncQ2weavLA,34523
+dissect.target-3.9.dev38.dist-info/METADATA,sha256=F2OhtulG3gqAU4z12JPG5uc8kjBJmrZJ8Jcgl86OdjI,10234
+dissect.target-3.9.dev38.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+dissect.target-3.9.dev38.dist-info/entry_points.txt,sha256=tvFPa-Ap-gakjaPwRc6Fl6mxHzxEZ_arAVU-IUYeo_s,447
+dissect.target-3.9.dev38.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
+dissect.target-3.9.dev38.dist-info/RECORD,,