Alek Ratzloff
522c62a55c
* Plugins all derive from Omnibot.Plugin. There still is a base plugin, in case we want to have another plugin backend instead of a GenServer * All plugins are monitored by a unique Plugin.Supervisor, which is in turn started by the PluginSupervisor (yes this is confusing, yes it needs to be renamed) * Any other auxiliary child processes may be started through the Plugin.children/1 function. * By default, plugins have a CfgState process which is an Agent that keeps track of the plugin's configuration and state * Plugin API is now called through the GenServer backend for better synchronicity. * Very few changes to the front-facing Plugin API, which is nice Signed-off-by: Alek Ratzloff <alekratz@gmail.com>
88 lines
2.2 KiB
Elixir
88 lines
2.2 KiB
Elixir
defmodule Omnibot.Plugin do
|
|
@default_opts [include_base: true, opts: [strategy: :one_for_one]]
|
|
|
|
defmodule CfgState do
|
|
use Agent
|
|
|
|
def start_link(opts) do
|
|
{cfg, opts} = Keyword.pop(opts, :cfg)
|
|
{state, opts} = Keyword.pop(opts, :state, nil)
|
|
Agent.start_link(fn -> {cfg, state} end, opts)
|
|
end
|
|
|
|
def cfg(pid), do: Agent.get(pid, fn {cfg, _} -> cfg end)
|
|
|
|
def state(pid), do: Agent.get(pid, fn {_, state} -> state end)
|
|
|
|
def update_state(pid, fun, timeout \\ 5000) do
|
|
Agent.update(pid, fn {cfg, state} -> {cfg, apply(fun, [state])} end, timeout)
|
|
#Agent.update(pid, &{&1, apply(fun, [&1])}, timeout)
|
|
end
|
|
end
|
|
|
|
defmacro __using__(opts) do
|
|
opts = opts ++ @default_opts
|
|
|
|
quote generated: true do
|
|
use GenServer
|
|
use Omnibot.Plugin.Base
|
|
|
|
## Client API
|
|
|
|
def start_link(opts) do
|
|
{cfg, opts} = Keyword.pop(opts, :cfg)
|
|
GenServer.start_link(__MODULE__, cfg, opts)
|
|
end
|
|
|
|
def cfg() do
|
|
Omnibot.Plugin.CfgState.cfg(__MODULE__.CfgState)
|
|
end
|
|
|
|
def state() do
|
|
Omnibot.Plugin.CfgState.state(__MODULE__.CfgState)
|
|
end
|
|
|
|
def update_state(fun) do
|
|
Omnibot.Plugin.CfgState.update_state(__MODULE__.CfgState, fun)
|
|
end
|
|
|
|
@impl Omnibot.Plugin.Base
|
|
def handle_msg(irc, msg) do
|
|
GenServer.cast(__MODULE__, {:handle_msg, irc, msg})
|
|
end
|
|
|
|
## Server callbacks
|
|
|
|
@impl GenServer
|
|
def init(_cfg) do
|
|
{:ok, nil}
|
|
end
|
|
|
|
@impl GenServer
|
|
def handle_cast({:handle_msg, irc, msg}, state) do
|
|
on_msg(irc, msg)
|
|
{:noreply, state}
|
|
end
|
|
|
|
defp base_children(cfg, state) when unquote(opts[:include_base]) do
|
|
[
|
|
{Omnibot.Plugin.CfgState, cfg: cfg, state: state, name: __MODULE__.CfgState},
|
|
{__MODULE__, name: __MODULE__},
|
|
]
|
|
end
|
|
|
|
defp base_children(_cfg, _state), do: []
|
|
|
|
@impl Omnibot.Plugin
|
|
def children(cfg), do: []
|
|
|
|
def plugin_children(cfg, state), do: base_children(cfg, state) ++ children(cfg)
|
|
|
|
@behaviour Omnibot.Plugin
|
|
defoverridable Omnibot.Plugin
|
|
end
|
|
end
|
|
|
|
@callback children(cfg :: [atom: any]) :: [atom | {atom, [atom: any]} | {atom, any, [atom: any]}]
|
|
end
|