git.squeep.com Git - akkoma/blob - lib/pleroma/user/info.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.User.Info do
   6   use Ecto.Schema
   7   import Ecto.Changeset
   8
   9   alias Pleroma.User.Info
  10
  11   @type t :: %__MODULE__{}
  12
  13   embedded_schema do
  14     field(:banner, :map, default: %{})
  15     field(:background, :map, default: %{})
  16     field(:source_data, :map, default: %{})
  17     field(:note_count, :integer, default: 0)
  18     field(:follower_count, :integer, default: 0)
  19     field(:locked, :boolean, default: false)
  20     field(:confirmation_pending, :boolean, default: false)
  21     field(:confirmation_token, :string, default: nil)
  22     field(:default_scope, :string, default: "public")
  23     field(:blocks, {:array, :string}, default: [])
  24     field(:domain_blocks, {:array, :string}, default: [])
  25     field(:mutes, {:array, :string}, default: [])
  26     field(:muted_reblogs, {:array, :string}, default: [])
  27     field(:subscribers, {:array, :string}, default: [])
  28     field(:deactivated, :boolean, default: false)
  29     field(:no_rich_text, :boolean, default: false)
  30     field(:ap_enabled, :boolean, default: false)
  31     field(:is_moderator, :boolean, default: false)
  32     field(:is_admin, :boolean, default: false)
  33     field(:show_role, :boolean, default: true)
  34     field(:keys, :string, default: nil)
  35     field(:settings, :map, default: nil)
  36     field(:magic_key, :string, default: nil)
  37     field(:uri, :string, default: nil)
  38     field(:topic, :string, default: nil)
  39     field(:hub, :string, default: nil)
  40     field(:salmon, :string, default: nil)
  41     field(:hide_followers, :boolean, default: false)
  42     field(:hide_follows, :boolean, default: false)
  43     field(:hide_favorites, :boolean, default: true)
  44     field(:pinned_activities, {:array, :string}, default: [])
  45     field(:flavour, :string, default: nil)
  46     field(:email_notifications, :map, default: %{"digest" => false})
  47     field(:mascot, :map, default: nil)
  48     field(:emoji, {:array, :map}, default: [])
  49     field(:pleroma_settings_store, :map, default: %{})
  50
  51     field(:notification_settings, :map,
  52       default: %{
  53         "followers" => true,
  54         "follows" => true,
  55         "non_follows" => true,
  56         "non_followers" => true
  57       }
  58     )
  59
  60     field(:skip_thread_containment, :boolean, default: false)
  61
  62     # Found in the wild
  63     # ap_id -> Where is this used?
  64     # bio -> Where is this used?
  65     # avatar -> Where is this used?
  66     # fqn -> Where is this used?
  67     # host -> Where is this used?
  68     # subject _> Where is this used?
  69   end
  70
  71   def set_activation_status(info, deactivated) do
  72     params = %{deactivated: deactivated}
  73
  74     info
  75     |> cast(params, [:deactivated])
  76     |> validate_required([:deactivated])
  77   end
  78
  79   def update_notification_settings(info, settings) do
  80     settings =
  81       settings
  82       |> Enum.map(fn {k, v} -> {k, v in [true, "true", "True", "1"]} end)
  83       |> Map.new()
  84
  85     notification_settings =
  86       info.notification_settings
  87       |> Map.merge(settings)
  88       |> Map.take(["followers", "follows", "non_follows", "non_followers"])
  89
  90     params = %{notification_settings: notification_settings}
  91
  92     info
  93     |> cast(params, [:notification_settings])
  94     |> validate_required([:notification_settings])
  95   end
  96
  97   @doc """
  98   Update email notifications in the given User.Info struct.
  99
 100   Examples:
 101
 102       iex> update_email_notifications(%Pleroma.User.Info{email_notifications: %{"digest" => false}}, %{"digest" => true})
 103       %Pleroma.User.Info{email_notifications: %{"digest" => true}}
 104
 105   """
 106   @spec update_email_notifications(t(), map()) :: Ecto.Changeset.t()
 107   def update_email_notifications(info, settings) do
 108     email_notifications =
 109       info.email_notifications
 110       |> Map.merge(settings)
 111       |> Map.take(["digest"])
 112
 113     params = %{email_notifications: email_notifications}
 114     fields = [:email_notifications]
 115
 116     info
 117     |> cast(params, fields)
 118     |> validate_required(fields)
 119   end
 120
 121   def add_to_note_count(info, number) do
 122     set_note_count(info, info.note_count + number)
 123   end
 124
 125   def set_note_count(info, number) do
 126     params = %{note_count: Enum.max([0, number])}
 127
 128     info
 129     |> cast(params, [:note_count])
 130     |> validate_required([:note_count])
 131   end
 132
 133   def set_follower_count(info, number) do
 134     params = %{follower_count: Enum.max([0, number])}
 135
 136     info
 137     |> cast(params, [:follower_count])
 138     |> validate_required([:follower_count])
 139   end
 140
 141   def set_mutes(info, mutes) do
 142     params = %{mutes: mutes}
 143
 144     info
 145     |> cast(params, [:mutes])
 146     |> validate_required([:mutes])
 147   end
 148
 149   def set_blocks(info, blocks) do
 150     params = %{blocks: blocks}
 151
 152     info
 153     |> cast(params, [:blocks])
 154     |> validate_required([:blocks])
 155   end
 156
 157   def set_subscribers(info, subscribers) do
 158     params = %{subscribers: subscribers}
 159
 160     info
 161     |> cast(params, [:subscribers])
 162     |> validate_required([:subscribers])
 163   end
 164
 165   def add_to_mutes(info, muted) do
 166     set_mutes(info, Enum.uniq([muted | info.mutes]))
 167   end
 168
 169   def remove_from_mutes(info, muted) do
 170     set_mutes(info, List.delete(info.mutes, muted))
 171   end
 172
 173   def add_to_block(info, blocked) do
 174     set_blocks(info, Enum.uniq([blocked | info.blocks]))
 175   end
 176
 177   def remove_from_block(info, blocked) do
 178     set_blocks(info, List.delete(info.blocks, blocked))
 179   end
 180
 181   def add_to_subscribers(info, subscribed) do
 182     set_subscribers(info, Enum.uniq([subscribed | info.subscribers]))
 183   end
 184
 185   def remove_from_subscribers(info, subscribed) do
 186     set_subscribers(info, List.delete(info.subscribers, subscribed))
 187   end
 188
 189   def set_domain_blocks(info, domain_blocks) do
 190     params = %{domain_blocks: domain_blocks}
 191
 192     info
 193     |> cast(params, [:domain_blocks])
 194     |> validate_required([:domain_blocks])
 195   end
 196
 197   def add_to_domain_block(info, domain_blocked) do
 198     set_domain_blocks(info, Enum.uniq([domain_blocked | info.domain_blocks]))
 199   end
 200
 201   def remove_from_domain_block(info, domain_blocked) do
 202     set_domain_blocks(info, List.delete(info.domain_blocks, domain_blocked))
 203   end
 204
 205   def set_keys(info, keys) do
 206     params = %{keys: keys}
 207
 208     info
 209     |> cast(params, [:keys])
 210     |> validate_required([:keys])
 211   end
 212
 213   def remote_user_creation(info, params) do
 214     info
 215     |> cast(params, [
 216       :ap_enabled,
 217       :source_data,
 218       :banner,
 219       :locked,
 220       :magic_key,
 221       :uri,
 222       :hub,
 223       :topic,
 224       :salmon
 225     ])
 226   end
 227
 228   def user_upgrade(info, params) do
 229     info
 230     |> cast(params, [
 231       :ap_enabled,
 232       :source_data,
 233       :banner,
 234       :locked,
 235       :magic_key
 236     ])
 237   end
 238
 239   def profile_update(info, params) do
 240     info
 241     |> cast(params, [
 242       :locked,
 243       :no_rich_text,
 244       :default_scope,
 245       :banner,
 246       :hide_follows,
 247       :hide_followers,
 248       :hide_favorites,
 249       :background,
 250       :show_role,
 251       :skip_thread_containment,
 252       :pleroma_settings_store
 253     ])
 254   end
 255
 256   @spec confirmation_changeset(Info.t(), keyword()) :: Changeset.t()
 257   def confirmation_changeset(info, opts) do
 258     need_confirmation? = Keyword.get(opts, :need_confirmation)
 259
 260     params =
 261       if need_confirmation? do
 262         %{
 263           confirmation_pending: true,
 264           confirmation_token: :crypto.strong_rand_bytes(32) |> Base.url_encode64()
 265         }
 266       else
 267         %{
 268           confirmation_pending: false,
 269           confirmation_token: nil
 270         }
 271       end
 272
 273     cast(info, params, [:confirmation_pending, :confirmation_token])
 274   end
 275
 276   def mastodon_settings_update(info, settings) do
 277     params = %{settings: settings}
 278
 279     info
 280     |> cast(params, [:settings])
 281     |> validate_required([:settings])
 282   end
 283
 284   def mascot_update(info, url) do
 285     params = %{mascot: url}
 286
 287     info
 288     |> cast(params, [:mascot])
 289     |> validate_required([:mascot])
 290   end
 291
 292   def set_source_data(info, source_data) do
 293     params = %{source_data: source_data}
 294
 295     info
 296     |> cast(params, [:source_data])
 297     |> validate_required([:source_data])
 298   end
 299
 300   def admin_api_update(info, params) do
 301     info
 302     |> cast(params, [
 303       :is_moderator,
 304       :is_admin,
 305       :show_role
 306     ])
 307   end
 308
 309   def add_pinnned_activity(info, %Pleroma.Activity{id: id}) do
 310     if id not in info.pinned_activities do
 311       max_pinned_statuses = Pleroma.Config.get([:instance, :max_pinned_statuses], 0)
 312       params = %{pinned_activities: info.pinned_activities ++ [id]}
 313
 314       info
 315       |> cast(params, [:pinned_activities])
 316       |> validate_length(:pinned_activities,
 317         max: max_pinned_statuses,
 318         message: "You have already pinned the maximum number of statuses"
 319       )
 320     else
 321       change(info)
 322     end
 323   end
 324
 325   def remove_pinnned_activity(info, %Pleroma.Activity{id: id}) do
 326     params = %{pinned_activities: List.delete(info.pinned_activities, id)}
 327
 328     cast(info, params, [:pinned_activities])
 329   end
 330
 331   def roles(%Info{is_moderator: is_moderator, is_admin: is_admin}) do
 332     %{
 333       admin: is_admin,
 334       moderator: is_moderator
 335     }
 336   end
 337
 338   def add_reblog_mute(info, ap_id) do
 339     params = %{muted_reblogs: info.muted_reblogs ++ [ap_id]}
 340
 341     cast(info, params, [:muted_reblogs])
 342   end
 343
 344   def remove_reblog_mute(info, ap_id) do
 345     params = %{muted_reblogs: List.delete(info.muted_reblogs, ap_id)}
 346
 347     cast(info, params, [:muted_reblogs])
 348   end
 349 end