user.ex 15.6 KB
Newer Older
lain's avatar
lain committed
1 2
defmodule Pleroma.User do
  use Ecto.Schema
3

4
  import Ecto.{Changeset, Query}
5
  alias Pleroma.{Repo, User, Object, Web, Activity, Notification}
6
  alias Comeonin.Pbkdf2
lain's avatar
lain committed
7
  alias Pleroma.Web.{OStatus, Websub}
lain's avatar
lain committed
8
  alias Pleroma.Web.ActivityPub.{Utils, ActivityPub}
lain's avatar
lain committed
9 10

  schema "users" do
lain's avatar
lain committed
11 12 13 14 15 16 17 18 19 20 21 22 23
    field(:bio, :string)
    field(:email, :string)
    field(:name, :string)
    field(:nickname, :string)
    field(:password_hash, :string)
    field(:password, :string, virtual: true)
    field(:password_confirmation, :string, virtual: true)
    field(:following, {:array, :string}, default: [])
    field(:ap_id, :string)
    field(:avatar, :map)
    field(:local, :boolean, default: true)
    field(:info, :map, default: %{})
    field(:follower_address, :string)
lain's avatar
lain committed
24
    field(:search_distance, :float, virtual: true)
lain's avatar
lain committed
25
    has_many(:notifications, Notification)
lain's avatar
lain committed
26 27 28

    timestamps()
  end
lain's avatar
lain committed
29

lain's avatar
lain committed
30 31 32
  def avatar_url(user) do
    case user.avatar do
      %{"url" => [%{"href" => href} | _]} -> href
33
      _ -> "#{Web.base_url()}/images/avi.png"
lain's avatar
lain committed
34 35 36
    end
  end

lain's avatar
lain committed
37 38 39
  def banner_url(user) do
    case user.info["banner"] do
      %{"url" => [%{"href" => href} | _]} -> href
40
      _ -> "#{Web.base_url()}/images/banner.png"
lain's avatar
lain committed
41 42 43
    end
  end

lain's avatar
lain committed
44
  def ap_id(%User{nickname: nickname}) do
lain's avatar
lain committed
45
    "#{Web.base_url()}/users/#{nickname}"
lain's avatar
lain committed
46 47 48 49 50
  end

  def ap_followers(%User{} = user) do
    "#{ap_id(user)}/followers"
  end
lain's avatar
lain committed
51 52 53 54 55 56 57

  def follow_changeset(struct, params \\ %{}) do
    struct
    |> cast(params, [:following])
    |> validate_required([:following])
  end

58 59 60 61 62 63
  def info_changeset(struct, params \\ %{}) do
    struct
    |> cast(params, [:info])
    |> validate_required([:info])
  end

lain's avatar
lain committed
64
  def user_info(%User{} = user) do
65
    oneself = if user.local, do: 1, else: 0
lain's avatar
lain committed
66

lain's avatar
lain committed
67
    %{
68
      following_count: length(user.following) - oneself,
69
      note_count: user.info["note_count"] || 0,
70 71
      follower_count: user.info["follower_count"] || 0,
      locked: user.info["locked"] || false
lain's avatar
lain committed
72 73 74
    }
  end

lain's avatar
lain committed
75 76
  @email_regex ~r/^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/
  def remote_user_creation(params) do
lain's avatar
lain committed
77 78 79 80 81 82 83 84 85 86
    changes =
      %User{}
      |> cast(params, [:bio, :name, :ap_id, :nickname, :info, :avatar])
      |> validate_required([:name, :ap_id, :nickname])
      |> unique_constraint(:nickname)
      |> validate_format(:nickname, @email_regex)
      |> validate_length(:bio, max: 5000)
      |> validate_length(:name, max: 100)
      |> put_change(:local, false)

87
    if changes.valid? do
lain's avatar
lain committed
88 89 90 91
      case changes.changes[:info]["source_data"] do
        %{"followers" => followers} ->
          changes
          |> put_change(:follower_address, followers)
lain's avatar
lain committed
92

lain's avatar
lain committed
93 94
        _ ->
          followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
lain's avatar
lain committed
95

lain's avatar
lain committed
96 97 98
          changes
          |> put_change(:follower_address, followers)
      end
99 100 101
    else
      changes
    end
lain's avatar
lain committed
102 103
  end

lain's avatar
lain committed
104
  def update_changeset(struct, params \\ %{}) do
Thog's avatar
Thog committed
105
    struct
lain's avatar
lain committed
106 107 108
    |> cast(params, [:bio, :name])
    |> unique_constraint(:nickname)
    |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
lain's avatar
lain committed
109
    |> validate_length(:bio, max: 5000)
lain's avatar
lain committed
110 111 112
    |> validate_length(:name, min: 1, max: 100)
  end

lain's avatar
lain committed
113 114
  def upgrade_changeset(struct, params \\ %{}) do
    struct
lain's avatar
lain committed
115
    |> cast(params, [:bio, :name, :info, :follower_address, :avatar])
lain's avatar
lain committed
116 117
    |> unique_constraint(:nickname)
    |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
lain's avatar
lain committed
118 119
    |> validate_length(:bio, max: 5000)
    |> validate_length(:name, max: 100)
lain's avatar
lain committed
120 121
  end

Roger Braun's avatar
Roger Braun committed
122
  def password_update_changeset(struct, params) do
lain's avatar
lain committed
123 124 125 126 127
    changeset =
      struct
      |> cast(params, [:password, :password_confirmation])
      |> validate_required([:password, :password_confirmation])
      |> validate_confirmation(:password)
Roger Braun's avatar
Roger Braun committed
128 129 130

    if changeset.valid? do
      hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
lain's avatar
lain committed
131

Roger Braun's avatar
Roger Braun committed
132 133 134 135 136 137 138 139
      changeset
      |> put_change(:password_hash, hashed)
    else
      changeset
    end
  end

  def reset_password(user, data) do
lain's avatar
lain committed
140
    update_and_set_cache(password_update_changeset(user, data))
Roger Braun's avatar
Roger Braun committed
141 142
  end

lain's avatar
lain committed
143
  def register_changeset(struct, params \\ %{}) do
lain's avatar
lain committed
144 145 146 147 148 149 150 151 152 153 154
    changeset =
      struct
      |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
      |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
      |> validate_confirmation(:password)
      |> unique_constraint(:email)
      |> unique_constraint(:nickname)
      |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
      |> validate_format(:email, @email_regex)
      |> validate_length(:bio, max: 1000)
      |> validate_length(:name, min: 1, max: 100)
lain's avatar
lain committed
155 156

    if changeset.valid? do
157
      hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
lain's avatar
lain committed
158 159
      ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
      followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
lain's avatar
lain committed
160

lain's avatar
lain committed
161 162 163 164
      changeset
      |> put_change(:password_hash, hashed)
      |> put_change(:ap_id, ap_id)
      |> put_change(:following, [followers])
165
      |> put_change(:follower_address, followers)
lain's avatar
lain committed
166 167 168 169 170
    else
      changeset
    end
  end

171
  @user_config Application.get_env(:pleroma, :user)
squidboi's avatar
fixes  
squidboi committed
172
  @deny_follow_blocked Keyword.get(@user_config, :deny_follow_blocked)
173

174 175 176 177 178 179
  def maybe_direct_follow(%User{} = follower, %User{info: info} = followed) do
    user_info = user_info(followed)

    should_direct_follow =
      cond do
        # if the account is locked, don't pre-create the relationship
180
        user_info[:locked] == true ->
181 182 183
          false

        # if the users are blocking each other, we shouldn't even be here, but check for it anyway
squidboi's avatar
fixes  
squidboi committed
184
        @deny_follow_blocked and (User.blocks?(follower, followed) or User.blocks?(followed, follower)) ->
185 186 187 188 189 190 191 192 193 194 195 196 197 198
          false

        # if OStatus, then there is no three-way handshake to follow
        User.ap_enabled?(followed) != true ->
          true

        # if there are no other reasons not to, just pre-create the relationship
        true ->
          true
      end

    if should_direct_follow do
      follow(follower, followed)
    else
199
      {:ok, follower}
200 201 202
    end
  end

203
  @user_config Application.get_env(:pleroma, :user)
squidboi's avatar
fixes  
squidboi committed
204
  @deny_follow_blocked Keyword.get(@user_config, :deny_follow_blocked)
205

lain's avatar
lain committed
206
  def follow(%User{} = follower, %User{info: info} = followed) do
207
    ap_followers = followed.follower_address
208

209 210 211
    cond do
      following?(follower, followed) or info["deactivated"] ->
        {:error, "Could not follow user: #{followed.nickname} is already on your list."}
lain's avatar
lain committed
212

squidboi's avatar
fixes  
squidboi committed
213
      @deny_follow_blocked and blocks?(followed, follower) ->
214
        {:error, "Could not follow user: #{followed.nickname} blocked you."}
lain's avatar
lain committed
215

216 217 218 219 220 221 222 223
      true ->
        if !followed.local && follower.local && !ap_enabled?(followed) do
          Websub.subscribe(follower, followed)
        end

        following =
          [ap_followers | follower.following]
          |> Enum.uniq()
224

225 226 227 228
        follower =
          follower
          |> follow_changeset(%{following: following})
          |> update_and_set_cache
229

230 231 232
        {:ok, _} = update_follower_count(followed)

        follower
233
    end
lain's avatar
lain committed
234
  end
lain's avatar
lain committed
235 236

  def unfollow(%User{} = follower, %User{} = followed) do
237
    ap_followers = followed.follower_address
lain's avatar
lain committed
238

239
    if following?(follower, followed) and follower.ap_id != followed.ap_id do
lain's avatar
lain committed
240 241 242
      following =
        follower.following
        |> List.delete(ap_followers)
lain's avatar
lain committed
243

lain's avatar
lain committed
244 245 246 247
      {:ok, follower} =
        follower
        |> follow_changeset(%{following: following})
        |> update_and_set_cache
248 249 250 251

      {:ok, followed} = update_follower_count(followed)

      {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
252
    else
253
      {:error, "Not subscribed!"}
254
    end
lain's avatar
lain committed
255
  end
256 257

  def following?(%User{} = follower, %User{} = followed) do
258
    Enum.member?(follower.following, followed.follower_address)
259
  end
lain's avatar
lain committed
260

lain's avatar
lain committed
261 262 263 264
  def get_by_ap_id(ap_id) do
    Repo.get_by(User, ap_id: ap_id)
  end

lain's avatar
lain committed
265 266
  def update_and_set_cache(changeset) do
    with {:ok, user} <- Repo.update(changeset) do
Thog's avatar
Thog committed
267 268 269
      Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
      Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
      Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
lain's avatar
lain committed
270 271 272 273 274 275
      {:ok, user}
    else
      e -> e
    end
  end

lain's avatar
lain committed
276 277 278 279 280
  def invalidate_cache(user) do
    Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
    Cachex.del(:user_cache, "nickname:#{user.nickname}")
  end

lain's avatar
lain committed
281
  def get_cached_by_ap_id(ap_id) do
282
    key = "ap_id:#{ap_id}"
Thog's avatar
Thog committed
283
    Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
lain's avatar
lain committed
284 285 286
  end

  def get_cached_by_nickname(nickname) do
287
    key = "nickname:#{nickname}"
Thog's avatar
Thog committed
288
    Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
lain's avatar
lain committed
289
  end
lain's avatar
lain committed
290

lain's avatar
lain committed
291
  def get_by_nickname(nickname) do
292 293 294
    Repo.get_by(User, nickname: nickname)
  end

295 296 297 298 299 300 301
  def get_by_nickname_or_email(nickname_or_email) do
    case user = Repo.get_by(User, nickname: nickname_or_email) do
      %User{} -> user
      nil -> Repo.get_by(User, email: nickname_or_email)
    end
  end

lain's avatar
lain committed
302 303
  def get_cached_user_info(user) do
    key = "user_info:#{user.id}"
Thog's avatar
Thog committed
304
    Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
lain's avatar
lain committed
305
  end
lain's avatar
lain committed
306

lain's avatar
lain committed
307 308 309 310 311 312 313 314 315
  def fetch_by_nickname(nickname) do
    ap_try = ActivityPub.make_user_from_nickname(nickname)

    case ap_try do
      {:ok, user} -> {:ok, user}
      _ -> OStatus.make_user(nickname)
    end
  end

lain's avatar
lain committed
316
  def get_or_fetch_by_nickname(nickname) do
lain's avatar
lain committed
317
    with %User{} = user <- get_by_nickname(nickname) do
lain's avatar
lain committed
318
      user
lain's avatar
lain committed
319 320 321 322 323 324 325 326
    else
      _e ->
        with [_nick, _domain] <- String.split(nickname, "@"),
             {:ok, user} <- fetch_by_nickname(nickname) do
          user
        else
          _e -> nil
        end
lain's avatar
lain committed
327
    end
lain's avatar
lain committed
328
  end
lain's avatar
lain committed
329

330 331 332 333 334 335 336 337 338 339
  def get_followers_query(%User{id: id, follower_address: follower_address}) do
    from(
      u in User,
      where: fragment("? <@ ?", ^[follower_address], u.following),
      where: u.id != ^id
    )
  end

  def get_followers(user) do
    q = get_followers_query(user)
lain's avatar
lain committed
340 341 342 343

    {:ok, Repo.all(q)}
  end

344 345 346 347 348 349 350 351 352 353
  def get_friends_query(%User{id: id, following: following}) do
    from(
      u in User,
      where: u.follower_address in ^following,
      where: u.id != ^id
    )
  end

  def get_friends(user) do
    q = get_friends_query(user)
lain's avatar
lain committed
354 355 356

    {:ok, Repo.all(q)}
  end
357

358 359 360 361 362 363
  def increase_note_count(%User{} = user) do
    note_count = (user.info["note_count"] || 0) + 1
    new_info = Map.put(user.info, "note_count", note_count)

    cs = info_changeset(user, %{info: new_info})

lain's avatar
lain committed
364
    update_and_set_cache(cs)
365 366
  end

367
  def decrease_note_count(%User{} = user) do
dashie's avatar
dashie committed
368
    note_count = user.info["note_count"] || 0
369 370 371 372 373 374 375 376
    note_count = if note_count <= 0, do: 0, else: note_count - 1
    new_info = Map.put(user.info, "note_count", note_count)

    cs = info_changeset(user, %{info: new_info})

    update_and_set_cache(cs)
  end

377
  def update_note_count(%User{} = user) do
lain's avatar
lain committed
378 379 380 381 382 383
    note_count_query =
      from(
        a in Object,
        where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
        select: count(a.id)
      )
384 385 386 387 388 389 390

    note_count = Repo.one(note_count_query)

    new_info = Map.put(user.info, "note_count", note_count)

    cs = info_changeset(user, %{info: new_info})

lain's avatar
lain committed
391
    update_and_set_cache(cs)
392 393 394
  end

  def update_follower_count(%User{} = user) do
lain's avatar
lain committed
395 396 397 398 399 400 401
    follower_count_query =
      from(
        u in User,
        where: ^user.follower_address in u.following,
        where: u.id != ^user.id,
        select: count(u.id)
      )
402 403 404 405 406 407 408

    follower_count = Repo.one(follower_count_query)

    new_info = Map.put(user.info, "follower_count", follower_count)

    cs = info_changeset(user, %{info: new_info})

lain's avatar
lain committed
409
    update_and_set_cache(cs)
410
  end
411

412
  def get_notified_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
413 414 415 416 417 418
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        where: u.local == true
      )
419 420 421

    Repo.all(query)
  end
lain's avatar
lain committed
422

423
  def get_recipients_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
424 425 426 427 428 429
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        or_where: fragment("? && ?", u.following, ^to)
      )
430

lain's avatar
lain committed
431
    query = from(u in query, where: u.local == true)
432

433 434 435
    Repo.all(query)
  end

lain's avatar
lain committed
436
  def search(query, resolve) do
437 438 439
    # strip the beginning @ off if there is a query
    query = String.trim_leading(query, "@")

lain's avatar
lain committed
440 441 442
    if resolve do
      User.get_or_fetch_by_nickname(query)
    end
lain's avatar
lain committed
443

lain's avatar
lain committed
444
    inner =
lain's avatar
lain committed
445 446
      from(
        u in User,
lain's avatar
lain committed
447
        select_merge: %{
kaniini's avatar
kaniini committed
448 449 450 451 452 453 454 455
          search_distance:
            fragment(
              "? <-> (? || ?)",
              ^query,
              u.nickname,
              u.name
            )
        }
lain's avatar
lain committed
456 457
      )

kaniini's avatar
kaniini committed
458 459 460 461 462 463
    q =
      from(
        s in subquery(inner),
        order_by: s.search_distance,
        limit: 20
      )
lain's avatar
lain committed
464

lain's avatar
lain committed
465 466
    Repo.all(q)
  end
lain's avatar
lain committed
467 468 469 470 471 472 473

  def block(user, %{ap_id: ap_id}) do
    blocks = user.info["blocks"] || []
    new_blocks = Enum.uniq([ap_id | blocks])
    new_info = Map.put(user.info, "blocks", new_blocks)

    cs = User.info_changeset(user, %{info: new_info})
lain's avatar
lain committed
474
    update_and_set_cache(cs)
lain's avatar
lain committed
475 476 477 478 479 480 481 482
  end

  def unblock(user, %{ap_id: ap_id}) do
    blocks = user.info["blocks"] || []
    new_blocks = List.delete(blocks, ap_id)
    new_info = Map.put(user.info, "blocks", new_blocks)

    cs = User.info_changeset(user, %{info: new_info})
lain's avatar
lain committed
483
    update_and_set_cache(cs)
lain's avatar
lain committed
484 485 486 487 488 489 490
  end

  def blocks?(user, %{ap_id: ap_id}) do
    blocks = user.info["blocks"] || []
    Enum.member?(blocks, ap_id)
  end

lain's avatar
lain committed
491
  def local_user_query() do
lain's avatar
lain committed
492
    from(u in User, where: u.local == true)
lain's avatar
lain committed
493 494
  end

lain's avatar
lain committed
495
  def deactivate(%User{} = user) do
lain's avatar
lain committed
496 497
    new_info = Map.put(user.info, "deactivated", true)
    cs = User.info_changeset(user, %{info: new_info})
lain's avatar
lain committed
498
    update_and_set_cache(cs)
lain's avatar
lain committed
499
  end
lain's avatar
lain committed
500

lain's avatar
lain committed
501
  def delete(%User{} = user) do
lain's avatar
lain committed
502 503 504
    {:ok, user} = User.deactivate(user)

    # Remove all relationships
lain's avatar
lain committed
505 506
    {:ok, followers} = User.get_followers(user)

lain's avatar
lain committed
507
    followers
lain's avatar
lain committed
508
    |> Enum.each(fn follower -> User.unfollow(follower, user) end)
lain's avatar
lain committed
509 510

    {:ok, friends} = User.get_friends(user)
lain's avatar
lain committed
511

lain's avatar
lain committed
512
    friends
lain's avatar
lain committed
513
    |> Enum.each(fn followed -> User.unfollow(user, followed) end)
lain's avatar
lain committed
514

lain's avatar
lain committed
515
    query = from(a in Activity, where: a.actor == ^user.ap_id)
lain's avatar
lain committed
516 517

    Repo.all(query)
lain's avatar
lain committed
518
    |> Enum.each(fn activity ->
lain's avatar
lain committed
519
      case activity.data["type"] do
lain's avatar
lain committed
520 521 522 523 524 525
        "Create" ->
          ActivityPub.delete(Object.get_by_ap_id(activity.data["object"]["id"]))

        # TODO: Do something with likes, follows, repeats.
        _ ->
          "Doing nothing"
lain's avatar
lain committed
526 527 528
      end
    end)

lain's avatar
lain committed
529 530
    :ok
  end
531

532 533 534 535
  def get_or_fetch_by_ap_id(ap_id) do
    if user = get_by_ap_id(ap_id) do
      user
    else
lain's avatar
lain committed
536 537 538
      ap_try = ActivityPub.make_user_from_ap_id(ap_id)

      case ap_try do
lain's avatar
lain committed
539 540 541
        {:ok, user} ->
          user

lain's avatar
lain committed
542 543 544
        _ ->
          case OStatus.make_user(ap_id) do
            {:ok, user} -> user
feld's avatar
feld committed
545
            _ -> {:error, "Could not fetch by AP id"}
lain's avatar
lain committed
546
          end
547 548 549 550 551
      end
    end
  end

  # AP style
lain's avatar
lain committed
552 553 554 555 556 557 558
  def public_key_from_info(%{
        "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
      }) do
    key =
      :public_key.pem_decode(public_key_pem)
      |> hd()
      |> :public_key.pem_entry_decode()
559

lain's avatar
lain committed
560
    {:ok, key}
561 562 563 564 565 566 567
  end

  # OStatus Magic Key
  def public_key_from_info(%{"magic_key" => magic_key}) do
    {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
  end

568
  def get_public_key_for_ap_id(ap_id) do
569 570
    with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
         {:ok, public_key} <- public_key_from_info(user.info) do
571 572 573 574 575
      {:ok, public_key}
    else
      _ -> :error
    end
  end
lain's avatar
lain committed
576

577 578 579
  defp blank?(""), do: nil
  defp blank?(n), do: n

lain's avatar
lain committed
580
  def insert_or_update_user(data) do
lain's avatar
lain committed
581 582 583 584
    data =
      data
      |> Map.put(:name, blank?(data[:name]) || data[:nickname])

lain's avatar
lain committed
585 586 587
    cs = User.remote_user_creation(data)
    Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
  end
588

589
  def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
lain's avatar
lain committed
590
  def ap_enabled?(_), do: false
lain's avatar
lain committed
591 592 593 594 595 596 597 598

  def get_or_fetch(uri_or_nickname) do
    if String.starts_with?(uri_or_nickname, "http") do
      get_or_fetch_by_ap_id(uri_or_nickname)
    else
      get_or_fetch_by_nickname(uri_or_nickname)
    end
  end
lain's avatar
lain committed
599
end