firezone/elixir/apps/web/lib/web.ex

defmodule Web do
  @moduledoc """
  The entrypoint for defining your web interface, such
  as controllers, components, channels, and so on.

  This can be used in your application as:

      use Web, :controller
      use Web, :html

  The definitions below will be executed for every controller,
  component, etc, so keep them short and clean, focused
  on imports, uses and aliases.

  Do NOT define functions inside the quoted expressions
  below. Instead, define additional modules and import
  those modules here.
  """

  def static_paths,
    do: ~w(assets fonts images .well-known site.webmanifest favicon.ico robots.txt)

  def router do
    quote do
      use Phoenix.Router, helpers: false

      # Import common connection and controller functions to use in pipelines
      import Plug.Conn
      import Phoenix.Controller
      import Phoenix.LiveView.Router
    end
  end

  def channel do
    quote do
      use Phoenix.Channel
    end
  end

  def controller do
    quote do
      use Phoenix.Controller,
        formats: [:html, :json, :xml],
        layouts: [html: Web.Layouts]

      import Plug.Conn
      import Web.Gettext
      import Web.ControllerDocumentation

      unquote(verified_routes())
    end
  end

  def live_view(opts \\ []) do
    quote do
      use Phoenix.LiveView,
        layout: Keyword.get(unquote(opts), :layout, {Web.Layouts, :app})

      import Web.LiveTable

      unquote(html_helpers())

      # we ignore Swoosh messages that can crash LV process in dev/test mode
      if Mix.env() in [:dev, :test] do
        def handle_info({:email, %Swoosh.Email{}}, socket) do
          {:noreply, socket}
        end
      end

      # ignore "disconnect" message that is broadcasted for some pages
      # because of subscription for relay/gateway group events
      def handle_info("disconnect", socket) do
        {:noreply, socket}
      end
    end
  end

  def live_component do
    quote do
      use Phoenix.LiveComponent

      unquote(html_helpers())
    end
  end

  def component_library do
    quote do
      use Phoenix.Component

      # Core UI components and translation
      unquote(components())

      # Shortcut for generating JS commands
      alias Phoenix.LiveView.JS

      # Routes generation with the ~p sigil
      unquote(verified_routes())
    end
  end

  def xml do
    quote do
      import Phoenix.Template, only: [embed_templates: 1]

      # Import convenience functions from controllers
      import Phoenix.Controller,
        only: [get_csrf_token: 0, view_module: 1, view_template: 1]

      # Include general helpers for rendering HTML
      unquote(html_helpers())
    end
  end

  def html do
    quote do
      use Phoenix.Component

      # Import convenience functions from controllers
      import Phoenix.Controller,
        only: [get_csrf_token: 0, view_module: 1, view_template: 1]

      # Include general helpers for rendering HTML
      unquote(html_helpers())
    end
  end

  defp html_helpers do
    quote do
      # HTML escaping functionality
      import Phoenix.HTML

      # Core UI components and translation
      unquote(components())

      # Shortcut for generating JS commands
      alias Phoenix.LiveView.JS

      # Routes generation with the ~p sigil
      unquote(verified_routes())
    end
  end

  def verified_routes do
    quote do
      use Phoenix.VerifiedRoutes,
        endpoint: Web.Endpoint,
        router: Web.Router,
        statics: Web.static_paths()
    end
  end

  def components do
    quote do
      import Web.CoreComponents
      import Web.NavigationComponents
      import Web.FormComponents
      import Web.TableComponents
      import Web.PageComponents
      import Web.Gettext
    end
  end

  @doc """
  When used, dispatch to the appropriate controller/view/etc.
  """
  defmacro __using__(which) when is_atom(which) do
    apply(__MODULE__, which, [])
  end

  defmacro __using__({which, opts}) when is_atom(which) do
    apply(__MODULE__, which, [opts])
  end
end