user.ex 16 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 172 173 174 175 176
  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
177
        user_info[:locked] == true ->
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
          false

        # if the users are blocking each other, we shouldn't even be here, but check for it anyway
        User.blocks?(follower, followed) == true or User.blocks?(followed, follower) == true ->
          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
196
      {:ok, follower}
197 198 199
    end
  end

lain's avatar
lain committed
200
  def follow(%User{} = follower, %User{info: info} = followed) do
201
    ap_followers = followed.follower_address
202

203 204 205
    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
206

207 208
      blocks?(followed, follower) ->
        {:error, "Could not follow user: #{followed.nickname} blocked you."}
lain's avatar
lain committed
209

210 211 212 213 214 215 216 217
      true ->
        if !followed.local && follower.local && !ap_enabled?(followed) do
          Websub.subscribe(follower, followed)
        end

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

219 220 221 222
        follower =
          follower
          |> follow_changeset(%{following: following})
          |> update_and_set_cache
223

224 225 226
        {:ok, _} = update_follower_count(followed)

        follower
227
    end
lain's avatar
lain committed
228
  end
lain's avatar
lain committed
229 230

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

233
    if following?(follower, followed) and follower.ap_id != followed.ap_id do
lain's avatar
lain committed
234 235 236
      following =
        follower.following
        |> List.delete(ap_followers)
lain's avatar
lain committed
237

lain's avatar
lain committed
238 239 240 241
      {:ok, follower} =
        follower
        |> follow_changeset(%{following: following})
        |> update_and_set_cache
242 243 244 245

      {:ok, followed} = update_follower_count(followed)

      {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
246
    else
247
      {:error, "Not subscribed!"}
248
    end
lain's avatar
lain committed
249
  end
250 251

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

lain's avatar
lain committed
255 256 257 258
  def get_by_ap_id(ap_id) do
    Repo.get_by(User, ap_id: ap_id)
  end

lain's avatar
lain committed
259 260
  def update_and_set_cache(changeset) do
    with {:ok, user} <- Repo.update(changeset) do
Thog's avatar
Thog committed
261 262 263
      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
264 265 266 267 268 269
      {:ok, user}
    else
      e -> e
    end
  end

lain's avatar
lain committed
270 271 272 273 274
  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
275
  def get_cached_by_ap_id(ap_id) do
276
    key = "ap_id:#{ap_id}"
Thog's avatar
Thog committed
277
    Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
lain's avatar
lain committed
278 279 280
  end

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

lain's avatar
lain committed
285
  def get_by_nickname(nickname) do
286 287 288
    Repo.get_by(User, nickname: nickname)
  end

289 290 291 292 293 294 295
  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
296 297
  def get_cached_user_info(user) do
    key = "user_info:#{user.id}"
Thog's avatar
Thog committed
298
    Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
lain's avatar
lain committed
299
  end
lain's avatar
lain committed
300

lain's avatar
lain committed
301 302 303 304 305 306 307 308 309
  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
310
  def get_or_fetch_by_nickname(nickname) do
lain's avatar
lain committed
311
    with %User{} = user <- get_by_nickname(nickname) do
lain's avatar
lain committed
312
      user
lain's avatar
lain committed
313 314 315 316 317 318 319 320
    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
321
    end
lain's avatar
lain committed
322
  end
lain's avatar
lain committed
323

324 325 326 327 328 329 330 331 332 333
  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
334 335 336 337

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

338 339 340 341 342 343 344 345 346 347
  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
348 349 350

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

352 353 354 355 356 357
  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
358
    update_and_set_cache(cs)
359 360
  end

361
  def decrease_note_count(%User{} = user) do
dashie's avatar
dashie committed
362
    note_count = user.info["note_count"] || 0
363 364 365 366 367 368 369 370
    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

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

    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
385
    update_and_set_cache(cs)
386 387 388
  end

  def update_follower_count(%User{} = user) do
lain's avatar
lain committed
389 390 391 392 393 394 395
    follower_count_query =
      from(
        u in User,
        where: ^user.follower_address in u.following,
        where: u.id != ^user.id,
        select: count(u.id)
      )
396 397 398 399 400 401 402

    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
403
    update_and_set_cache(cs)
404
  end
405

406
  def get_notified_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
407 408 409 410 411 412
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        where: u.local == true
      )
413 414 415

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

417
  def get_recipients_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
418 419 420 421 422 423
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        or_where: fragment("? && ?", u.following, ^to)
      )
424

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

427 428 429
    Repo.all(query)
  end

lain's avatar
lain committed
430
  def search(query, resolve) do
431 432 433
    # strip the beginning @ off if there is a query
    query = String.trim_leading(query, "@")

lain's avatar
lain committed
434 435 436
    if resolve do
      User.get_or_fetch_by_nickname(query)
    end
lain's avatar
lain committed
437

lain's avatar
lain committed
438
    inner =
lain's avatar
lain committed
439 440
      from(
        u in User,
lain's avatar
lain committed
441
        select_merge: %{
kaniini's avatar
kaniini committed
442 443 444 445 446 447 448 449
          search_distance:
            fragment(
              "? <-> (? || ?)",
              ^query,
              u.nickname,
              u.name
            )
        }
lain's avatar
lain committed
450 451
      )

kaniini's avatar
kaniini committed
452 453 454 455 456 457
    q =
      from(
        s in subquery(inner),
        order_by: s.search_distance,
        limit: 20
      )
lain's avatar
lain committed
458

lain's avatar
lain committed
459 460
    Repo.all(q)
  end
lain's avatar
lain committed
461 462 463 464 465 466 467

  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
468
    update_and_set_cache(cs)
lain's avatar
lain committed
469 470 471 472 473 474 475 476
  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
477
    update_and_set_cache(cs)
lain's avatar
lain committed
478 479 480 481
  end

  def blocks?(user, %{ap_id: ap_id}) do
    blocks = user.info["blocks"] || []
eal's avatar
eal committed
482 483
    domain_blocks = user.info["domain_blocks"] || []
    %{host: host} = URI.parse(ap_id)
eal's avatar
eal committed
484 485 486 487 488

    Enum.member?(blocks, ap_id) ||
      Enum.any?(domain_blocks, fn domain ->
        host == domain
      end)
eal's avatar
eal committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
  end

  def block_domain(user, domain) do
    domain_blocks = user.info["domain_blocks"] || []
    new_blocks = Enum.uniq([domain | domain_blocks])
    new_info = Map.put(user.info, "domain_blocks", new_blocks)

    cs = User.info_changeset(user, %{info: new_info})
    update_and_set_cache(cs)
  end

  def unblock_domain(user, domain) do
    blocks = user.info["domain_blocks"] || []
    new_blocks = List.delete(blocks, domain)
    new_info = Map.put(user.info, "domain_blocks", new_blocks)

    cs = User.info_changeset(user, %{info: new_info})
    update_and_set_cache(cs)
lain's avatar
lain committed
507 508
  end

lain's avatar
lain committed
509
  def local_user_query() do
lain's avatar
lain committed
510
    from(u in User, where: u.local == true)
lain's avatar
lain committed
511 512
  end

lain's avatar
lain committed
513
  def deactivate(%User{} = user) do
lain's avatar
lain committed
514 515
    new_info = Map.put(user.info, "deactivated", true)
    cs = User.info_changeset(user, %{info: new_info})
lain's avatar
lain committed
516
    update_and_set_cache(cs)
lain's avatar
lain committed
517
  end
lain's avatar
lain committed
518

lain's avatar
lain committed
519
  def delete(%User{} = user) do
lain's avatar
lain committed
520 521 522
    {:ok, user} = User.deactivate(user)

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

lain's avatar
lain committed
525
    followers
lain's avatar
lain committed
526
    |> Enum.each(fn follower -> User.unfollow(follower, user) end)
lain's avatar
lain committed
527 528

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

lain's avatar
lain committed
530
    friends
lain's avatar
lain committed
531
    |> Enum.each(fn followed -> User.unfollow(user, followed) end)
lain's avatar
lain committed
532

lain's avatar
lain committed
533
    query = from(a in Activity, where: a.actor == ^user.ap_id)
lain's avatar
lain committed
534 535

    Repo.all(query)
lain's avatar
lain committed
536
    |> Enum.each(fn activity ->
lain's avatar
lain committed
537
      case activity.data["type"] do
lain's avatar
lain committed
538 539 540 541 542 543
        "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
544 545 546
      end
    end)

lain's avatar
lain committed
547 548
    :ok
  end
549

550 551 552 553
  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
554 555 556
      ap_try = ActivityPub.make_user_from_ap_id(ap_id)

      case ap_try do
lain's avatar
lain committed
557 558 559
        {:ok, user} ->
          user

lain's avatar
lain committed
560 561 562
        _ ->
          case OStatus.make_user(ap_id) do
            {:ok, user} -> user
feld's avatar
feld committed
563
            _ -> {:error, "Could not fetch by AP id"}
lain's avatar
lain committed
564
          end
565 566 567 568 569
      end
    end
  end

  # AP style
lain's avatar
lain committed
570 571 572 573 574 575 576
  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()
577

lain's avatar
lain committed
578
    {:ok, key}
579 580 581 582 583 584 585
  end

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

586
  def get_public_key_for_ap_id(ap_id) do
587 588
    with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
         {:ok, public_key} <- public_key_from_info(user.info) do
589 590 591 592 593
      {:ok, public_key}
    else
      _ -> :error
    end
  end
lain's avatar
lain committed
594

595 596 597
  defp blank?(""), do: nil
  defp blank?(n), do: n

lain's avatar
lain committed
598
  def insert_or_update_user(data) do
lain's avatar
lain committed
599 600 601 602
    data =
      data
      |> Map.put(:name, blank?(data[:name]) || data[:nickname])

lain's avatar
lain committed
603 604 605
    cs = User.remote_user_creation(data)
    Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
  end
606

607
  def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
lain's avatar
lain committed
608
  def ap_enabled?(_), do: false
lain's avatar
lain committed
609 610 611 612 613 614 615 616

  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
617
end