user.ex 12.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 11 12 13 14 15

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

    timestamps()
  end
lain's avatar
lain committed
28

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

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

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

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

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

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

lain's avatar
lain committed
63
  def user_info(%User{} = user) do
64
    oneself = if user.local, do: 1, else: 0
lain's avatar
lain committed
65
    %{
66
      following_count: length(user.following) - oneself,
67 68
      note_count: user.info["note_count"] || 0,
      follower_count: user.info["follower_count"] || 0
lain's avatar
lain committed
69 70 71
    }
  end

lain's avatar
lain committed
72 73
  @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
74
    changes = %User{}
lain's avatar
lain committed
75 76
    |> cast(params, [:bio, :name, :ap_id, :nickname, :info, :avatar])
    |> validate_required([:name, :ap_id, :nickname])
lain's avatar
lain committed
77 78
    |> unique_constraint(:nickname)
    |> validate_format(:nickname, @email_regex)
79
    |> validate_length(:bio, max: 5000)
lain's avatar
lain committed
80
    |> validate_length(:name, max: 100)
lain's avatar
lain committed
81
    |> put_change(:local, false)
82
    if changes.valid? do
lain's avatar
lain committed
83 84 85 86 87 88 89 90 91
      case changes.changes[:info]["source_data"] do
        %{"followers" => followers} ->
          changes
          |> put_change(:follower_address, followers)
        _ ->
          followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
          changes
          |> put_change(:follower_address, followers)
      end
92 93 94
    else
      changes
    end
lain's avatar
lain committed
95 96
  end

lain's avatar
lain committed
97
  def update_changeset(struct, params \\ %{}) do
Thog's avatar
Thog committed
98
    struct
lain's avatar
lain committed
99 100 101 102 103 104 105
    |> cast(params, [:bio, :name])
    |> unique_constraint(:nickname)
    |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
    |> validate_length(:bio, min: 1, max: 1000)
    |> validate_length(:name, min: 1, max: 100)
  end

Roger Braun's avatar
Roger Braun committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
  def password_update_changeset(struct, params) do
    changeset = struct
    |> cast(params, [:password, :password_confirmation])
    |> validate_required([:password, :password_confirmation])
    |> validate_confirmation(:password)

    if changeset.valid? do
      hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
      changeset
      |> put_change(:password_hash, hashed)
    else
      changeset
    end
  end

  def reset_password(user, data) do
lain's avatar
lain committed
122
    update_and_set_cache(password_update_changeset(user, data))
Roger Braun's avatar
Roger Braun committed
123 124
  end

lain's avatar
lain committed
125 126 127 128 129 130 131
  def register_changeset(struct, params \\ %{}) do
    changeset = struct
    |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
    |> validate_required([:bio, :email, :name, :nickname, :password, :password_confirmation])
    |> validate_confirmation(:password)
    |> unique_constraint(:email)
    |> unique_constraint(:nickname)
dtluna's avatar
dtluna committed
132
    |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
lain's avatar
lain committed
133
    |> validate_format(:email, @email_regex)
lain's avatar
lain committed
134 135
    |> validate_length(:bio, min: 1, max: 1000)
    |> validate_length(:name, min: 1, max: 100)
lain's avatar
lain committed
136 137

    if changeset.valid? do
138
      hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
lain's avatar
lain committed
139 140 141 142 143 144
      ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
      followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
      changeset
      |> put_change(:password_hash, hashed)
      |> put_change(:ap_id, ap_id)
      |> put_change(:following, [followers])
145
      |> put_change(:follower_address, followers)
lain's avatar
lain committed
146 147 148 149 150
    else
      changeset
    end
  end

lain's avatar
lain committed
151
  def follow(%User{} = follower, %User{info: info} = followed) do
152
    ap_followers = followed.follower_address
153

lain's avatar
lain committed
154
    if following?(follower, followed) or info["deactivated"] do
155 156
      {:error,
       "Could not follow user: #{followed.nickname} is already on your list."}
157
    else
158
      if !followed.local && follower.local && !ap_enabled?(followed) do
lain's avatar
lain committed
159 160 161
        Websub.subscribe(follower, followed)
      end

162 163
      following = [ap_followers | follower.following]
      |> Enum.uniq
lain's avatar
lain committed
164

165
      follower = follower
166
      |> follow_changeset(%{following: following})
lain's avatar
lain committed
167
      |> update_and_set_cache
168

Thog's avatar
Thog committed
169
      {:ok, _} = update_follower_count(followed)
170 171

      follower
172
    end
lain's avatar
lain committed
173
  end
lain's avatar
lain committed
174 175

  def unfollow(%User{} = follower, %User{} = followed) do
176
    ap_followers = followed.follower_address
177
    if following?(follower, followed) and follower.ap_id != followed.ap_id do
178 179
      following = follower.following
      |> List.delete(ap_followers)
lain's avatar
lain committed
180

dtluna's avatar
dtluna committed
181
      { :ok, follower } = follower
182
      |> follow_changeset(%{following: following})
lain's avatar
lain committed
183
      |> update_and_set_cache
184 185 186 187

      {:ok, followed} = update_follower_count(followed)

      {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
188
    else
189
      {:error, "Not subscribed!"}
190
    end
lain's avatar
lain committed
191
  end
192 193

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

lain's avatar
lain committed
197 198 199 200
  def get_by_ap_id(ap_id) do
    Repo.get_by(User, ap_id: ap_id)
  end

lain's avatar
lain committed
201 202 203 204 205 206 207 208 209 210 211
  def update_and_set_cache(changeset) do
    with {:ok, user} <- Repo.update(changeset) do
      Cachex.set(:user_cache, "ap_id:#{user.ap_id}", user)
      Cachex.set(:user_cache, "nickname:#{user.nickname}", user)
      Cachex.set(:user_cache, "user_info:#{user.id}", user_info(user))
      {:ok, user}
    else
      e -> e
    end
  end

lain's avatar
lain committed
212
  def get_cached_by_ap_id(ap_id) do
213
    key = "ap_id:#{ap_id}"
lain's avatar
lain committed
214
    Cachex.get!(:user_cache, key, fallback: fn(_) -> get_by_ap_id(ap_id) end)
lain's avatar
lain committed
215 216 217
  end

  def get_cached_by_nickname(nickname) do
218
    key = "nickname:#{nickname}"
lain's avatar
lain committed
219
    Cachex.get!(:user_cache, key, fallback: fn(_) -> get_or_fetch_by_nickname(nickname) end)
lain's avatar
lain committed
220
  end
lain's avatar
lain committed
221

lain's avatar
lain committed
222
  def get_by_nickname(nickname) do
223 224 225
    Repo.get_by(User, nickname: nickname)
  end

lain's avatar
lain committed
226 227 228 229
  def get_cached_user_info(user) do
    key = "user_info:#{user.id}"
    Cachex.get!(:user_cache, key, fallback: fn(_) -> user_info(user) end)
  end
lain's avatar
lain committed
230

lain's avatar
lain committed
231 232 233 234 235 236 237 238 239
  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
240 241 242 243
  def get_or_fetch_by_nickname(nickname) do
    with %User{} = user <- get_by_nickname(nickname)  do
      user
    else _e ->
Thog's avatar
Thog committed
244
      with [_nick, _domain] <- String.split(nickname, "@"),
lain's avatar
lain committed
245
           {:ok, user} <- fetch_by_nickname(nickname) do
lain's avatar
lain committed
246 247 248 249
        user
      else _e -> nil
      end
    end
lain's avatar
lain committed
250
  end
lain's avatar
lain committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267

  # TODO: these queries could be more efficient if the type in postgresql wasn't map, but array.
  def get_followers(%User{id: id, follower_address: follower_address}) do
    q = from u in User,
      where: fragment("? @> ?", u.following, ^follower_address ),
      where: u.id != ^id

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

  def get_friends(%User{id: id, following: following}) do
    q = from u in User,
      where: u.follower_address in ^following,
      where: u.id != ^id

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

269 270 271 272 273 274
  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
275
    update_and_set_cache(cs)
276 277
  end

278 279
  def update_note_count(%User{} = user) do
    note_count_query = from a in Object,
280
      where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
281 282 283 284 285 286 287 288
      select: count(a.id)

    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
289
    update_and_set_cache(cs)
290 291 292 293 294
  end

  def update_follower_count(%User{} = user) do
    follower_count_query = from u in User,
      where: fragment("? @> ?", u.following, ^user.follower_address),
295
      where: u.id != ^user.id,
296 297 298 299 300 301 302 303
      select: count(u.id)

    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
304
    update_and_set_cache(cs)
305
  end
306

Thog's avatar
Thog committed
307
  def get_notified_from_activity(%Activity{data: %{"to" => to}}) do
308 309 310 311 312 313
    query = from u in User,
      where: u.ap_id in ^to,
      where: u.local == true

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

Thog's avatar
Thog committed
315
  def get_recipients_from_activity(%Activity{data: %{"to" => to}}) do
316 317 318 319
    query = from u in User,
      where: u.ap_id in ^to,
      or_where: fragment("? \\\?| ?", u.following, ^to)

320 321 322
    query = from u in query,
      where: u.local == true

323 324 325
    Repo.all(query)
  end

lain's avatar
lain committed
326 327 328 329 330 331 332 333 334
  def search(query, resolve) do
    if resolve do
      User.get_or_fetch_by_nickname(query)
    end
    q = from u in User,
      where: fragment("(to_tsvector('english', ?) || to_tsvector('english', ?)) @@ plainto_tsquery('english', ?)", u.nickname, u.name, ^query),
      limit: 20
    Repo.all(q)
  end
lain's avatar
lain committed
335 336 337 338 339 340 341

  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
342
    update_and_set_cache(cs)
lain's avatar
lain committed
343 344 345 346 347 348 349 350
  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
351
    update_and_set_cache(cs)
lain's avatar
lain committed
352 353 354 355 356 357 358
  end

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

lain's avatar
lain committed
359 360 361 362 363
  def local_user_query() do
    from u in User,
      where: u.local == true
  end

lain's avatar
lain committed
364 365 366
  def deactivate (%User{} = user) do
    new_info = Map.put(user.info, "deactivated", true)
    cs = User.info_changeset(user, %{info: new_info})
lain's avatar
lain committed
367
    update_and_set_cache(cs)
lain's avatar
lain committed
368
  end
lain's avatar
lain committed
369 370 371 372 373 374 375 376 377 378 379 380 381

  def delete (%User{} = user) do
    {:ok, user} = User.deactivate(user)

    # Remove all relationships
    {:ok, followers } = User.get_followers(user)
    followers
    |> Enum.each(fn (follower) -> User.unfollow(follower, user) end)

    {:ok, friends} = User.get_friends(user)
    friends
    |> Enum.each(fn (followed) -> User.unfollow(user, followed) end)

lain's avatar
lain committed
382 383 384 385 386 387 388 389 390 391 392
    query = from a in Activity,
      where: a.actor == ^user.ap_id

    Repo.all(query)
    |> Enum.each(fn (activity) ->
      case activity.data["type"] do
        "Create" -> ActivityPub.delete(Object.get_by_ap_id(activity.data["object"]["id"]))
        _ -> "Doing nothing" # TODO: Do something with likes, follows, repeats.
      end
    end)

lain's avatar
lain committed
393 394
    :ok
  end
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
  def get_or_fetch_by_ap_id(ap_id) do
    if user = get_by_ap_id(ap_id) do
      user
    else
      with {:ok, user} <- ActivityPub.make_user_from_ap_id(ap_id) do
        user
      end
    end
  end

  # AP style
  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()

     {:ok, key}
  end

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

420
  def get_public_key_for_ap_id(ap_id) do
421 422
    with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
         {:ok, public_key} <- public_key_from_info(user.info) do
423 424 425 426 427
      {:ok, public_key}
    else
      _ -> :error
    end
  end
lain's avatar
lain committed
428

429 430 431
  defp blank?(""), do: nil
  defp blank?(n), do: n

lain's avatar
lain committed
432
  def insert_or_update_user(data) do
433 434
    data = data
    |> Map.put(:name, blank?(data[:name]) || data[:nickname])
lain's avatar
lain committed
435 436 437
    cs = User.remote_user_creation(data)
    Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
  end
438

439
  def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
lain's avatar
lain committed
440
end