1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web do
7 A module that keeps using definitions for controllers,
10 This can be used in your application as:
12 use Pleroma.Web, :controller
13 use Pleroma.Web, :view
15 The definitions below will be executed for every view,
16 controller, etc, so keep them short and clean, focused
17 on imports, uses and aliases.
19 Do NOT define functions inside the quoted expressions
25 use Phoenix.Controller, namespace: Pleroma.Web
28 import Pleroma.Web.Gettext
29 import Pleroma.Web.Router.Helpers
30 import Pleroma.Web.TranslationHelpers
32 alias Pleroma.Plugs.PlugHelper
36 defp set_put_layout(conn, _) do
37 put_layout(conn, Pleroma.Config.get(:app_layout, "app.html"))
40 # Marks a plug as intentionally skipped
41 # (states that the plug is not called for a good reason, not by a mistake)
42 defp skip_plug(conn, plug_module) do
43 PlugHelper.append_to_skipped_plugs(conn, plug_module)
46 # Here we can apply before-action hooks (e.g. verify whether auth checks were preformed)
47 defp action(conn, params) do
48 if conn.private[:auth_expected] &&
49 not PlugHelper.plug_called_or_skipped?(conn, Pleroma.Plugs.OAuthScopesPlug) do
53 "Security violation: OAuth scopes check was neither handled nor explicitly skipped."
66 root: "lib/pleroma/web/templates",
67 namespace: Pleroma.Web
69 # Import convenience functions from controllers
70 import Phoenix.Controller, only: [get_csrf_token: 0, get_flash: 2, view_module: 1]
72 import Pleroma.Web.ErrorHelpers
73 import Pleroma.Web.Gettext
74 import Pleroma.Web.Router.Helpers
78 @doc "Same as `render/3` but wrapped in a rescue block"
79 def safe_render(view, template, assigns \\ %{}) do
80 Phoenix.View.render(view, template, assigns)
84 "#{__MODULE__} failed to render #{inspect({view, template})}\n" <>
85 Exception.format(:error, error, __STACKTRACE__)
92 Same as `render_many/4` but wrapped in rescue block.
94 def safe_render_many(collection, view, template, assigns \\ %{}) do
95 Enum.map(collection, fn resource ->
96 as = Map.get(assigns, :as) || view.__resource__
97 assigns = Map.put(assigns, as, resource)
98 safe_render(view, template, assigns)
108 # credo:disable-for-next-line Credo.Check.Consistency.MultiAliasImportRequireUse
110 import Phoenix.Controller
116 # credo:disable-for-next-line Credo.Check.Consistency.MultiAliasImportRequireUse
118 import Pleroma.Web.Gettext
123 When used, dispatch to the appropriate controller/view/etc.
125 defmacro __using__(which) when is_atom(which) do
126 apply(__MODULE__, which, [])
130 Pleroma.Web.Endpoint.url()