:py:mod:`dissect.target.plugins.filesystem.resolver`
====================================================

.. py:module:: dissect.target.plugins.filesystem.resolver


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.filesystem.resolver.ResolverPlugin




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.filesystem.resolver.re_quoted
   dissect.target.plugins.filesystem.resolver.REPLACEMENTS
   dissect.target.plugins.filesystem.resolver.FALLBACK_SEARCH_PATHS


.. py:data:: re_quoted

   

.. py:data:: REPLACEMENTS
   :value: [('/systemroot/', '/%systemroot%/')]

   

.. py:data:: FALLBACK_SEARCH_PATHS
   :value: ['sysvol/windows/system32', 'sysvol/windows/syswow64', 'sysvol/windows']

   

.. py:class:: ResolverPlugin(target: dissect.target.Target)


   Bases: :py:obj:`dissect.target.plugin.Plugin`

   Base class for plugins.

   Plugins can optionally be namespaced by specifying the ``__namespace__``
   class attribute. Namespacing results in your plugin needing to be prefixed
   with this namespace when being called. For example, if your plugin has
   specified ``test`` as namespace and a function called ``example``, you must
   call your plugin with ``test.example``::

   A ``Plugin`` class has the following private class attributes:

   - ``__namespace__``
   - ``__record_descriptors__``

   With the following three being assigned in :func:`register`:

   - ``__plugin__``
   - ``__functions__``
   - ``__exports__``

   Additionally, the methods and attributes of :class:`Plugin` receive more private attributes
   by using decorators.

   The :func:`export` decorator adds the following private attributes

   - ``__exported__``
   - ``__output__``: Set with the :func:`export` decorator.
   - ``__record__``: Set with the :func:`export` decorator.

   The :func:`internal` decorator and :class:`InternalPlugin` set the ``__internal__`` attribute.
   Finally. :func:`args` decorator sets the ``__args__`` attribute.

   :param target: The :class:`~dissect.target.target.Target` object to load the plugin for.

   .. py:method:: check_compatible() -> None

      Perform a compatibility check with the target.

      This function should return ``None`` if the plugin is compatible with
      the current target (``self.target``). For example, check if a certain
      file exists.
      Otherwise it should raise an ``UnsupportedPluginError``.

      :raises UnsupportedPluginError: If the plugin could not be loaded.


   .. py:method:: resolve(path: str, user: Optional[str] = None) -> str

      Resolve a partial path string to a file or directory present in the target.

      For Windows known file locations are searched, e.g. paths from the %path% variable and common path extentions
      tried. If a user SID is provided that user's %path% variable is used.


   .. py:method:: resolve_windows(path: str, user_sid: Optional[str] = None) -> str


   .. py:method:: resolve_default(path: str, user_id: Optional[str] = None) -> str