user.ex 14.3 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 70
      note_count: user.info["note_count"] || 0,
      follower_count: user.info["follower_count"] || 0
lain's avatar
lain committed
71 72 73
    }
  end

lain's avatar
lain committed
74 75
  @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
76 77 78 79 80 81 82 83 84 85
    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)

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

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

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

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

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

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

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

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

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

lain's avatar
lain committed
142
  def register_changeset(struct, params \\ %{}) do
lain's avatar
lain committed
143 144 145 146 147 148 149 150 151 152 153
    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
154 155

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

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

lain's avatar
lain committed
170
  def follow(%User{} = follower, %User{info: info} = followed) do
171
    ap_followers = followed.follower_address
172

lain's avatar
lain committed
173
    if following?(follower, followed) or info["deactivated"] do
lain's avatar
lain committed
174
      {:error, "Could not follow user: #{followed.nickname} is already on your list."}
175
    else
176
      if !followed.local && follower.local && !ap_enabled?(followed) do
lain's avatar
lain committed
177 178 179
        Websub.subscribe(follower, followed)
      end

lain's avatar
lain committed
180 181 182
      following =
        [ap_followers | follower.following]
        |> Enum.uniq()
lain's avatar
lain committed
183

lain's avatar
lain committed
184 185 186 187
      follower =
        follower
        |> follow_changeset(%{following: following})
        |> update_and_set_cache
188

Thog's avatar
Thog committed
189
      {:ok, _} = update_follower_count(followed)
190 191

      follower
192
    end
lain's avatar
lain committed
193
  end
lain's avatar
lain committed
194 195

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

198
    if following?(follower, followed) and follower.ap_id != followed.ap_id do
lain's avatar
lain committed
199 200 201
      following =
        follower.following
        |> List.delete(ap_followers)
lain's avatar
lain committed
202

lain's avatar
lain committed
203 204 205 206
      {:ok, follower} =
        follower
        |> follow_changeset(%{following: following})
        |> update_and_set_cache
207 208 209 210

      {:ok, followed} = update_follower_count(followed)

      {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
211
    else
212
      {:error, "Not subscribed!"}
213
    end
lain's avatar
lain committed
214
  end
215 216

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

lain's avatar
lain committed
220 221 222 223
  def get_by_ap_id(ap_id) do
    Repo.get_by(User, ap_id: ap_id)
  end

lain's avatar
lain committed
224 225
  def update_and_set_cache(changeset) do
    with {:ok, user} <- Repo.update(changeset) do
Thog's avatar
Thog committed
226 227 228
      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
229 230 231 232 233 234
      {:ok, user}
    else
      e -> e
    end
  end

lain's avatar
lain committed
235 236 237 238 239
  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
240
  def get_cached_by_ap_id(ap_id) do
241
    key = "ap_id:#{ap_id}"
Thog's avatar
Thog committed
242
    Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
lain's avatar
lain committed
243 244 245
  end

  def get_cached_by_nickname(nickname) do
246
    key = "nickname:#{nickname}"
Thog's avatar
Thog committed
247
    Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
lain's avatar
lain committed
248
  end
lain's avatar
lain committed
249

lain's avatar
lain committed
250
  def get_by_nickname(nickname) do
251 252 253
    Repo.get_by(User, nickname: nickname)
  end

254 255 256 257 258 259 260
  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
261 262
  def get_cached_user_info(user) do
    key = "user_info:#{user.id}"
Thog's avatar
Thog committed
263
    Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
lain's avatar
lain committed
264
  end
lain's avatar
lain committed
265

lain's avatar
lain committed
266 267 268 269 270 271 272 273 274
  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
275
  def get_or_fetch_by_nickname(nickname) do
lain's avatar
lain committed
276
    with %User{} = user <- get_by_nickname(nickname) do
lain's avatar
lain committed
277
      user
lain's avatar
lain committed
278 279 280 281 282 283 284 285
    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
286
    end
lain's avatar
lain committed
287
  end
lain's avatar
lain committed
288

289 290 291 292 293 294 295 296 297 298
  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
299 300 301 302

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

303 304 305 306 307 308 309 310 311 312
  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
313 314 315

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

317 318 319 320 321 322
  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
323
    update_and_set_cache(cs)
324 325
  end

326
  def decrease_note_count(%User{} = user) do
dashie's avatar
dashie committed
327
    note_count = user.info["note_count"] || 0
328 329 330 331 332 333 334 335
    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

336
  def update_note_count(%User{} = user) do
lain's avatar
lain committed
337 338 339 340 341 342
    note_count_query =
      from(
        a in Object,
        where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
        select: count(a.id)
      )
343 344 345 346 347 348 349

    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
350
    update_and_set_cache(cs)
351 352 353
  end

  def update_follower_count(%User{} = user) do
lain's avatar
lain committed
354 355 356 357 358 359 360
    follower_count_query =
      from(
        u in User,
        where: ^user.follower_address in u.following,
        where: u.id != ^user.id,
        select: count(u.id)
      )
361 362 363 364 365 366 367

    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
368
    update_and_set_cache(cs)
369
  end
370

371
  def get_notified_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
372 373 374 375 376 377
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        where: u.local == true
      )
378 379 380

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

382
  def get_recipients_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
383 384 385 386 387 388
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        or_where: fragment("? && ?", u.following, ^to)
      )
389

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

392 393 394
    Repo.all(query)
  end

lain's avatar
lain committed
395
  def search(query, resolve) do
396 397 398
    # strip the beginning @ off if there is a query
    query = String.trim_leading(query, "@")

lain's avatar
lain committed
399 400 401
    if resolve do
      User.get_or_fetch_by_nickname(query)
    end
lain's avatar
lain committed
402

lain's avatar
lain committed
403
    inner =
lain's avatar
lain committed
404 405
      from(
        u in User,
lain's avatar
lain committed
406
        select_merge: %{
kaniini's avatar
kaniini committed
407 408 409 410 411 412 413 414
          search_distance:
            fragment(
              "? <-> (? || ?)",
              ^query,
              u.nickname,
              u.name
            )
        }
lain's avatar
lain committed
415 416
      )

kaniini's avatar
kaniini committed
417 418 419 420 421 422
    q =
      from(
        s in subquery(inner),
        order_by: s.search_distance,
        limit: 20
      )
lain's avatar
lain committed
423

lain's avatar
lain committed
424 425
    Repo.all(q)
  end
lain's avatar
lain committed
426 427 428 429 430 431 432

  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
433
    update_and_set_cache(cs)
lain's avatar
lain committed
434 435 436 437 438 439 440 441
  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
442
    update_and_set_cache(cs)
lain's avatar
lain committed
443 444 445 446 447 448 449
  end

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

lain's avatar
lain committed
450
  def local_user_query() do
lain's avatar
lain committed
451
    from(u in User, where: u.local == true)
lain's avatar
lain committed
452 453
  end

lain's avatar
lain committed
454
  def deactivate(%User{} = user) do
lain's avatar
lain committed
455 456
    new_info = Map.put(user.info, "deactivated", true)
    cs = User.info_changeset(user, %{info: new_info})
lain's avatar
lain committed
457
    update_and_set_cache(cs)
lain's avatar
lain committed
458
  end
lain's avatar
lain committed
459

lain's avatar
lain committed
460
  def delete(%User{} = user) do
lain's avatar
lain committed
461 462 463
    {:ok, user} = User.deactivate(user)

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

lain's avatar
lain committed
466
    followers
lain's avatar
lain committed
467
    |> Enum.each(fn follower -> User.unfollow(follower, user) end)
lain's avatar
lain committed
468 469

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

lain's avatar
lain committed
471
    friends
lain's avatar
lain committed
472
    |> Enum.each(fn followed -> User.unfollow(user, followed) end)
lain's avatar
lain committed
473

lain's avatar
lain committed
474
    query = from(a in Activity, where: a.actor == ^user.ap_id)
lain's avatar
lain committed
475 476

    Repo.all(query)
lain's avatar
lain committed
477
    |> Enum.each(fn activity ->
lain's avatar
lain committed
478
      case activity.data["type"] do
lain's avatar
lain committed
479 480 481 482 483 484
        "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
485 486 487
      end
    end)

lain's avatar
lain committed
488 489
    :ok
  end
490

491 492 493 494
  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
495 496 497
      ap_try = ActivityPub.make_user_from_ap_id(ap_id)

      case ap_try do
lain's avatar
lain committed
498 499 500
        {:ok, user} ->
          user

lain's avatar
lain committed
501 502 503
        _ ->
          case OStatus.make_user(ap_id) do
            {:ok, user} -> user
feld's avatar
feld committed
504
            _ -> {:error, "Could not fetch by AP id"}
lain's avatar
lain committed
505
          end
506 507 508 509 510
      end
    end
  end

  # AP style
lain's avatar
lain committed
511 512 513 514 515 516 517
  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()
518

lain's avatar
lain committed
519
    {:ok, key}
520 521 522 523 524 525 526
  end

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

527
  def get_public_key_for_ap_id(ap_id) do
528 529
    with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
         {:ok, public_key} <- public_key_from_info(user.info) do
530 531 532 533 534
      {:ok, public_key}
    else
      _ -> :error
    end
  end
lain's avatar
lain committed
535

536 537 538
  defp blank?(""), do: nil
  defp blank?(n), do: n

lain's avatar
lain committed
539
  def insert_or_update_user(data) do
lain's avatar
lain committed
540 541 542 543
    data =
      data
      |> Map.put(:name, blank?(data[:name]) || data[:nickname])

lain's avatar
lain committed
544 545 546
    cs = User.remote_user_creation(data)
    Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
  end
547

548
  def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
lain's avatar
lain committed
549
  def ap_enabled?(_), do: false
lain's avatar
lain committed
550 551 552 553 554 555 556 557

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