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