96 lines
2.8 KiB
Python
96 lines
2.8 KiB
Python
import re
|
|
import warnings
|
|
from collections.abc import Sequence
|
|
from dataclasses import dataclass
|
|
from dataclasses import fields
|
|
from dataclasses import is_dataclass
|
|
from typing import Any
|
|
from typing import ClassVar
|
|
from typing import TYPE_CHECKING
|
|
|
|
import mitmproxy.flow
|
|
|
|
if TYPE_CHECKING:
|
|
import mitmproxy.addonmanager
|
|
import mitmproxy.log
|
|
|
|
|
|
class Hook:
|
|
name: ClassVar[str]
|
|
|
|
def args(self) -> list[Any]:
|
|
args = []
|
|
for field in fields(self): # type: ignore[arg-type]
|
|
args.append(getattr(self, field.name))
|
|
return args
|
|
|
|
def __new__(cls, *args, **kwargs):
|
|
if cls is Hook:
|
|
raise TypeError("Hook may not be instantiated directly.")
|
|
if not is_dataclass(cls):
|
|
raise TypeError("Subclass is not a dataclass.")
|
|
return super().__new__(cls)
|
|
|
|
def __init_subclass__(cls, **kwargs):
|
|
# initialize .name attribute. HttpRequestHook -> http_request
|
|
if cls.__dict__.get("name", None) is None:
|
|
name = cls.__name__.replace("Hook", "")
|
|
cls.name = re.sub("(?!^)([A-Z]+)", r"_\1", name).lower()
|
|
if cls.name in all_hooks:
|
|
other = all_hooks[cls.name]
|
|
warnings.warn(
|
|
f"Two conflicting event classes for {cls.name}: {cls} and {other}",
|
|
RuntimeWarning,
|
|
)
|
|
if cls.name == "":
|
|
return # don't register Hook class.
|
|
all_hooks[cls.name] = cls
|
|
|
|
# define a custom hash and __eq__ function so that events are hashable and not comparable.
|
|
cls.__hash__ = object.__hash__ # type: ignore
|
|
cls.__eq__ = object.__eq__ # type: ignore
|
|
|
|
|
|
all_hooks: dict[str, type[Hook]] = {}
|
|
|
|
|
|
@dataclass
|
|
class ConfigureHook(Hook):
|
|
"""
|
|
Called when configuration changes. The updated argument is a
|
|
set-like object containing the keys of all changed options. This
|
|
event is called during startup with all options in the updated set.
|
|
"""
|
|
|
|
updated: set[str]
|
|
|
|
|
|
@dataclass
|
|
class DoneHook(Hook):
|
|
"""
|
|
Called when the addon shuts down, either by being removed from
|
|
the mitmproxy instance, or when mitmproxy itself shuts down. On
|
|
shutdown, this event is called after the event loop is
|
|
terminated, guaranteeing that it will be the final event an addon
|
|
sees. Note that log handlers are shut down at this point, so
|
|
calls to log functions will produce no output.
|
|
"""
|
|
|
|
|
|
@dataclass
|
|
class RunningHook(Hook):
|
|
"""
|
|
Called when the proxy is completely up and running. At this point,
|
|
you can expect all addons to be loaded and all options to be set.
|
|
"""
|
|
|
|
|
|
@dataclass
|
|
class UpdateHook(Hook):
|
|
"""
|
|
Update is called when one or more flow objects have been modified,
|
|
usually from a different addon.
|
|
"""
|
|
|
|
flows: Sequence[mitmproxy.flow.Flow]
|