1 defmodule Pleroma.User do
4 import Ecto.{Changeset, Query}
5 alias Pleroma.{Repo, User, Object, Web, Activity, Notification}
7 alias Pleroma.Web.{OStatus, Websub}
8 alias Pleroma.Web.ActivityPub.{Utils, ActivityPub}
12 field(:email, :string)
14 field(:nickname, :string)
15 field(:password_hash, :string)
16 field(:password, :string, virtual: true)
17 field(:password_confirmation, :string, virtual: true)
18 field(:following, {:array, :string}, default: [])
19 field(:ap_id, :string)
21 field(:local, :boolean, default: true)
22 field(:info, :map, default: %{})
23 field(:follower_address, :string)
24 field(:search_distance, :float, virtual: true)
25 has_many(:notifications, Notification)
30 def avatar_url(user) do
32 %{"url" => [%{"href" => href} | _]} -> href
33 _ -> "#{Web.base_url()}/images/avi.png"
37 def banner_url(user) do
38 case user.info["banner"] do
39 %{"url" => [%{"href" => href} | _]} -> href
40 _ -> "#{Web.base_url()}/images/banner.png"
44 def ap_id(%User{nickname: nickname}) do
45 "#{Web.base_url()}/users/#{nickname}"
48 def ap_followers(%User{} = user) do
49 "#{ap_id(user)}/followers"
52 def follow_changeset(struct, params \\ %{}) do
54 |> cast(params, [:following])
55 |> validate_required([:following])
58 def info_changeset(struct, params \\ %{}) do
60 |> cast(params, [:info])
61 |> validate_required([:info])
64 def user_info(%User{} = user) do
65 oneself = if user.local, do: 1, else: 0
68 following_count: length(user.following) - oneself,
69 note_count: user.info["note_count"] || 0,
70 follower_count: user.info["follower_count"] || 0,
71 locked: user.info["locked"] || false
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])?)*$/
76 def remote_user_creation(params) do
79 |> cast(params, [:bio, :name, :ap_id, :nickname, :info, :avatar])
80 |> validate_required([:name, :ap_id, :nickname])
81 |> unique_constraint(:nickname)
82 |> validate_format(:nickname, @email_regex)
83 |> validate_length(:bio, max: 5000)
84 |> validate_length(:name, max: 100)
85 |> put_change(:local, false)
88 case changes.changes[:info]["source_data"] do
89 %{"followers" => followers} ->
91 |> put_change(:follower_address, followers)
94 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
97 |> put_change(:follower_address, followers)
104 def update_changeset(struct, params \\ %{}) do
106 |> cast(params, [:bio, :name])
107 |> unique_constraint(:nickname)
108 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
109 |> validate_length(:bio, max: 5000)
110 |> validate_length(:name, min: 1, max: 100)
113 def upgrade_changeset(struct, params \\ %{}) do
115 |> cast(params, [:bio, :name, :info, :follower_address, :avatar])
116 |> unique_constraint(:nickname)
117 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
118 |> validate_length(:bio, max: 5000)
119 |> validate_length(:name, max: 100)
122 def password_update_changeset(struct, params) do
125 |> cast(params, [:password, :password_confirmation])
126 |> validate_required([:password, :password_confirmation])
127 |> validate_confirmation(:password)
129 if changeset.valid? do
130 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
133 |> put_change(:password_hash, hashed)
139 def reset_password(user, data) do
140 update_and_set_cache(password_update_changeset(user, data))
143 def register_changeset(struct, params \\ %{}) do
146 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
147 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
148 |> validate_confirmation(:password)
149 |> unique_constraint(:email)
150 |> unique_constraint(:nickname)
151 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
152 |> validate_format(:email, @email_regex)
153 |> validate_length(:bio, max: 1000)
154 |> validate_length(:name, min: 1, max: 100)
156 if changeset.valid? do
157 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
158 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
159 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
162 |> put_change(:password_hash, hashed)
163 |> put_change(:ap_id, ap_id)
164 |> put_change(:following, [followers])
165 |> put_change(:follower_address, followers)
171 @user_config Application.get_env(:pleroma, :user)
172 @deny_follow_blocked Keyword.get(@user_config, :deny_follow_blocked)
174 def maybe_direct_follow(%User{} = follower, %User{info: info} = followed) do
175 user_info = user_info(followed)
177 should_direct_follow =
179 # if the account is locked, don't pre-create the relationship
180 user_info[:locked] == true ->
183 # if the users are blocking each other, we shouldn't even be here, but check for it anyway
184 @deny_follow_blocked and (User.blocks?(follower, followed) or User.blocks?(followed, follower)) ->
187 # if OStatus, then there is no three-way handshake to follow
188 User.ap_enabled?(followed) != true ->
191 # if there are no other reasons not to, just pre-create the relationship
196 if should_direct_follow do
197 follow(follower, followed)
203 @user_config Application.get_env(:pleroma, :user)
204 @deny_follow_blocked Keyword.get(@user_config, :deny_follow_blocked)
206 def follow(%User{} = follower, %User{info: info} = followed) do
207 ap_followers = followed.follower_address
210 following?(follower, followed) or info["deactivated"] ->
211 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
213 @deny_follow_blocked and blocks?(followed, follower) ->
214 {:error, "Could not follow user: #{followed.nickname} blocked you."}
217 if !followed.local && follower.local && !ap_enabled?(followed) do
218 Websub.subscribe(follower, followed)
222 [ap_followers | follower.following]
227 |> follow_changeset(%{following: following})
228 |> update_and_set_cache
230 {:ok, _} = update_follower_count(followed)
236 def unfollow(%User{} = follower, %User{} = followed) do
237 ap_followers = followed.follower_address
239 if following?(follower, followed) and follower.ap_id != followed.ap_id do
242 |> List.delete(ap_followers)
246 |> follow_changeset(%{following: following})
247 |> update_and_set_cache
249 {:ok, followed} = update_follower_count(followed)
251 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
253 {:error, "Not subscribed!"}
257 def following?(%User{} = follower, %User{} = followed) do
258 Enum.member?(follower.following, followed.follower_address)
261 def get_by_ap_id(ap_id) do
262 Repo.get_by(User, ap_id: ap_id)
265 def update_and_set_cache(changeset) do
266 with {:ok, user} <- Repo.update(changeset) do
267 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
268 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
269 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
276 def invalidate_cache(user) do
277 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
278 Cachex.del(:user_cache, "nickname:#{user.nickname}")
281 def get_cached_by_ap_id(ap_id) do
282 key = "ap_id:#{ap_id}"
283 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
286 def get_cached_by_nickname(nickname) do
287 key = "nickname:#{nickname}"
288 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
291 def get_by_nickname(nickname) do
292 Repo.get_by(User, nickname: nickname)
295 def get_by_nickname_or_email(nickname_or_email) do
296 case user = Repo.get_by(User, nickname: nickname_or_email) do
298 nil -> Repo.get_by(User, email: nickname_or_email)
302 def get_cached_user_info(user) do
303 key = "user_info:#{user.id}"
304 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
307 def fetch_by_nickname(nickname) do
308 ap_try = ActivityPub.make_user_from_nickname(nickname)
311 {:ok, user} -> {:ok, user}
312 _ -> OStatus.make_user(nickname)
316 def get_or_fetch_by_nickname(nickname) do
317 with %User{} = user <- get_by_nickname(nickname) do
321 with [_nick, _domain] <- String.split(nickname, "@"),
322 {:ok, user} <- fetch_by_nickname(nickname) do
330 def get_followers_query(%User{id: id, follower_address: follower_address}) do
333 where: fragment("? <@ ?", ^[follower_address], u.following),
338 def get_followers(user) do
339 q = get_followers_query(user)
344 def get_friends_query(%User{id: id, following: following}) do
347 where: u.follower_address in ^following,
352 def get_friends(user) do
353 q = get_friends_query(user)
358 def increase_note_count(%User{} = user) do
359 note_count = (user.info["note_count"] || 0) + 1
360 new_info = Map.put(user.info, "note_count", note_count)
362 cs = info_changeset(user, %{info: new_info})
364 update_and_set_cache(cs)
367 def decrease_note_count(%User{} = user) do
368 note_count = user.info["note_count"] || 0
369 note_count = if note_count <= 0, do: 0, else: note_count - 1
370 new_info = Map.put(user.info, "note_count", note_count)
372 cs = info_changeset(user, %{info: new_info})
374 update_and_set_cache(cs)
377 def update_note_count(%User{} = user) do
381 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
385 note_count = Repo.one(note_count_query)
387 new_info = Map.put(user.info, "note_count", note_count)
389 cs = info_changeset(user, %{info: new_info})
391 update_and_set_cache(cs)
394 def update_follower_count(%User{} = user) do
395 follower_count_query =
398 where: ^user.follower_address in u.following,
399 where: u.id != ^user.id,
403 follower_count = Repo.one(follower_count_query)
405 new_info = Map.put(user.info, "follower_count", follower_count)
407 cs = info_changeset(user, %{info: new_info})
409 update_and_set_cache(cs)
412 def get_notified_from_activity(%Activity{recipients: to}) do
416 where: u.ap_id in ^to,
417 where: u.local == true
423 def get_recipients_from_activity(%Activity{recipients: to}) do
427 where: u.ap_id in ^to,
428 or_where: fragment("? && ?", u.following, ^to)
431 query = from(u in query, where: u.local == true)
436 def search(query, resolve) do
437 # strip the beginning @ off if there is a query
438 query = String.trim_leading(query, "@")
441 User.get_or_fetch_by_nickname(query)
460 s in subquery(inner),
461 order_by: s.search_distance,
468 def block(user, %{ap_id: ap_id}) do
469 blocks = user.info["blocks"] || []
470 new_blocks = Enum.uniq([ap_id | blocks])
471 new_info = Map.put(user.info, "blocks", new_blocks)
473 cs = User.info_changeset(user, %{info: new_info})
474 update_and_set_cache(cs)
477 def unblock(user, %{ap_id: ap_id}) do
478 blocks = user.info["blocks"] || []
479 new_blocks = List.delete(blocks, ap_id)
480 new_info = Map.put(user.info, "blocks", new_blocks)
482 cs = User.info_changeset(user, %{info: new_info})
483 update_and_set_cache(cs)
486 def blocks?(user, %{ap_id: ap_id}) do
487 blocks = user.info["blocks"] || []
488 Enum.member?(blocks, ap_id)
491 def local_user_query() do
492 from(u in User, where: u.local == true)
495 def deactivate(%User{} = user) do
496 new_info = Map.put(user.info, "deactivated", true)
497 cs = User.info_changeset(user, %{info: new_info})
498 update_and_set_cache(cs)
501 def delete(%User{} = user) do
502 {:ok, user} = User.deactivate(user)
504 # Remove all relationships
505 {:ok, followers} = User.get_followers(user)
508 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
510 {:ok, friends} = User.get_friends(user)
513 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
515 query = from(a in Activity, where: a.actor == ^user.ap_id)
518 |> Enum.each(fn activity ->
519 case activity.data["type"] do
521 ActivityPub.delete(Object.get_by_ap_id(activity.data["object"]["id"]))
523 # TODO: Do something with likes, follows, repeats.
532 def get_or_fetch_by_ap_id(ap_id) do
533 if user = get_by_ap_id(ap_id) do
536 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
543 case OStatus.make_user(ap_id) do
545 _ -> {:error, "Could not fetch by AP id"}
552 def public_key_from_info(%{
553 "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
556 :public_key.pem_decode(public_key_pem)
558 |> :public_key.pem_entry_decode()
564 def public_key_from_info(%{"magic_key" => magic_key}) do
565 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
568 def get_public_key_for_ap_id(ap_id) do
569 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
570 {:ok, public_key} <- public_key_from_info(user.info) do
577 defp blank?(""), do: nil
578 defp blank?(n), do: n
580 def insert_or_update_user(data) do
583 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
585 cs = User.remote_user_creation(data)
586 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
589 def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
590 def ap_enabled?(_), do: false
592 def get_or_fetch(uri_or_nickname) do
593 if String.starts_with?(uri_or_nickname, "http") do
594 get_or_fetch_by_ap_id(uri_or_nickname)
596 get_or_fetch_by_nickname(uri_or_nickname)