git.squeep.com Git - akkoma/blob - lib/pleroma/user.ex

   1 defmodule Pleroma.User do
   2   use Ecto.Schema
   3
   4   import Ecto.{Changeset, Query}
   5   alias Pleroma.{Repo, User, Object, Web, Activity, Notification}
   6   alias Comeonin.Pbkdf2
   7   alias Pleroma.Web.{OStatus, Websub}
   8   alias Pleroma.Web.ActivityPub.{Utils, ActivityPub}
   9
  10   schema "users" do
  11     field :bio, :string
  12     field :email, :string
  13     field :name, :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
  20     field :avatar, :map
  21     field :local, :boolean, default: true
  22     field :info, :map, default: %{}
  23     field :follower_address, :string
  24     has_many :notifications, Notification
  25
  26     timestamps()
  27   end
  28
  29   def avatar_url(user) do
  30     case user.avatar do
  31       %{"url" => [%{"href" => href} | _]} -> href
  32       _ -> "#{Web.base_url()}/images/avi.png"
  33     end
  34   end
  35
  36   def banner_url(user) do
  37     case user.info["banner"] do
  38       %{"url" => [%{"href" => href} | _]} -> href
  39       _ -> "#{Web.base_url()}/images/banner.png"
  40     end
  41   end
  42
  43   def ap_id(%User{nickname: nickname}) do
  44     "#{Web.base_url}/users/#{nickname}"
  45   end
  46
  47   def ap_followers(%User{} = user) do
  48     "#{ap_id(user)}/followers"
  49   end
  50
  51   def follow_changeset(struct, params \\ %{}) do
  52     struct
  53     |> cast(params, [:following])
  54     |> validate_required([:following])
  55   end
  56
  57   def info_changeset(struct, params \\ %{}) do
  58     struct
  59     |> cast(params, [:info])
  60     |> validate_required([:info])
  61   end
  62
  63   def user_info(%User{} = user) do
  64     oneself = if user.local, do: 1, else: 0
  65     %{
  66       following_count: length(user.following) - oneself,
  67       note_count: user.info["note_count"] || 0,
  68       follower_count: user.info["follower_count"] || 0
  69     }
  70   end
  71
  72   @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])?)*$/
  73   def remote_user_creation(params) do
  74     changes = %User{}
  75     |> cast(params, [:bio, :name, :ap_id, :nickname, :info, :avatar])
  76     |> validate_required([:name, :ap_id, :nickname])
  77     |> unique_constraint(:nickname)
  78     |> validate_format(:nickname, @email_regex)
  79     |> validate_length(:bio, max: 5000)
  80     |> validate_length(:name, max: 100)
  81     |> put_change(:local, false)
  82     if changes.valid? do
  83       case changes.changes[:info]["source_data"] do
  84         %{"followers" => followers} ->
  85           changes
  86           |> put_change(:follower_address, followers)
  87         _ ->
  88           followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
  89           changes
  90           |> put_change(:follower_address, followers)
  91       end
  92     else
  93       changes
  94     end
  95   end
  96
  97   def update_changeset(struct, params \\ %{}) do
  98     struct
  99     |> cast(params, [:bio, :name])
 100     |> unique_constraint(:nickname)
 101     |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
 102     |> validate_length(:bio, min: 1, max: 1000)
 103     |> validate_length(:name, min: 1, max: 100)
 104   end
 105
 106   def upgrade_changeset(struct, params \\ %{}) do
 107     struct
 108     |> cast(params, [:bio, :name, :info, :follower_address])
 109     |> unique_constraint(:nickname)
 110     |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
 111     |> validate_length(:bio, min: 1, max: 1000)
 112     |> validate_length(:name, min: 1, max: 100)
 113   end
 114
 115   def password_update_changeset(struct, params) do
 116     changeset = struct
 117     |> cast(params, [:password, :password_confirmation])
 118     |> validate_required([:password, :password_confirmation])
 119     |> validate_confirmation(:password)
 120
 121     if changeset.valid? do
 122       hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
 123       changeset
 124       |> put_change(:password_hash, hashed)
 125     else
 126       changeset
 127     end
 128   end
 129
 130   def reset_password(user, data) do
 131     update_and_set_cache(password_update_changeset(user, data))
 132   end
 133
 134   def register_changeset(struct, params \\ %{}) do
 135     changeset = struct
 136     |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
 137     |> validate_required([:bio, :email, :name, :nickname, :password, :password_confirmation])
 138     |> validate_confirmation(:password)
 139     |> unique_constraint(:email)
 140     |> unique_constraint(:nickname)
 141     |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
 142     |> validate_format(:email, @email_regex)
 143     |> validate_length(:bio, min: 1, max: 1000)
 144     |> validate_length(:name, min: 1, max: 100)
 145
 146     if changeset.valid? do
 147       hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
 148       ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
 149       followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
 150       changeset
 151       |> put_change(:password_hash, hashed)
 152       |> put_change(:ap_id, ap_id)
 153       |> put_change(:following, [followers])
 154       |> put_change(:follower_address, followers)
 155     else
 156       changeset
 157     end
 158   end
 159
 160   def follow(%User{} = follower, %User{info: info} = followed) do
 161     ap_followers = followed.follower_address
 162
 163     if following?(follower, followed) or info["deactivated"] do
 164       {:error,
 165        "Could not follow user: #{followed.nickname} is already on your list."}
 166     else
 167       if !followed.local && follower.local && !ap_enabled?(followed) do
 168         Websub.subscribe(follower, followed)
 169       end
 170
 171       following = [ap_followers | follower.following]
 172       |> Enum.uniq
 173
 174       follower = follower
 175       |> follow_changeset(%{following: following})
 176       |> update_and_set_cache
 177
 178       {:ok, _} = update_follower_count(followed)
 179
 180       follower
 181     end
 182   end
 183
 184   def unfollow(%User{} = follower, %User{} = followed) do
 185     ap_followers = followed.follower_address
 186     if following?(follower, followed) and follower.ap_id != followed.ap_id do
 187       following = follower.following
 188       |> List.delete(ap_followers)
 189
 190       { :ok, follower } = follower
 191       |> follow_changeset(%{following: following})
 192       |> update_and_set_cache
 193
 194       {:ok, followed} = update_follower_count(followed)
 195
 196       {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
 197     else
 198       {:error, "Not subscribed!"}
 199     end
 200   end
 201
 202   def following?(%User{} = follower, %User{} = followed) do
 203     Enum.member?(follower.following, followed.follower_address)
 204   end
 205
 206   def get_by_ap_id(ap_id) do
 207     Repo.get_by(User, ap_id: ap_id)
 208   end
 209
 210   def update_and_set_cache(changeset) do
 211     with {:ok, user} <- Repo.update(changeset) do
 212       Cachex.set(:user_cache, "ap_id:#{user.ap_id}", user)
 213       Cachex.set(:user_cache, "nickname:#{user.nickname}", user)
 214       Cachex.set(:user_cache, "user_info:#{user.id}", user_info(user))
 215       {:ok, user}
 216     else
 217       e -> e
 218     end
 219   end
 220
 221   def get_cached_by_ap_id(ap_id) do
 222     key = "ap_id:#{ap_id}"
 223     Cachex.get!(:user_cache, key, fallback: fn(_) -> get_by_ap_id(ap_id) end)
 224   end
 225
 226   def get_cached_by_nickname(nickname) do
 227     key = "nickname:#{nickname}"
 228     Cachex.get!(:user_cache, key, fallback: fn(_) -> get_or_fetch_by_nickname(nickname) end)
 229   end
 230
 231   def get_by_nickname(nickname) do
 232     Repo.get_by(User, nickname: nickname)
 233   end
 234
 235   def get_cached_user_info(user) do
 236     key = "user_info:#{user.id}"
 237     Cachex.get!(:user_cache, key, fallback: fn(_) -> user_info(user) end)
 238   end
 239
 240   def fetch_by_nickname(nickname) do
 241     ap_try = ActivityPub.make_user_from_nickname(nickname)
 242
 243     case ap_try do
 244       {:ok, user} -> {:ok, user}
 245       _ -> OStatus.make_user(nickname)
 246     end
 247   end
 248
 249   def get_or_fetch_by_nickname(nickname) do
 250     with %User{} = user <- get_by_nickname(nickname)  do
 251       user
 252     else _e ->
 253       with [_nick, _domain] <- String.split(nickname, "@"),
 254            {:ok, user} <- fetch_by_nickname(nickname) do
 255         user
 256       else _e -> nil
 257       end
 258     end
 259   end
 260
 261   def get_followers(%User{id: id, follower_address: follower_address}) do
 262     q = from u in User,
 263       where: ^follower_address in u.following,
 264       where: u.id != ^id
 265
 266     {:ok, Repo.all(q)}
 267   end
 268
 269   def get_friends(%User{id: id, following: following}) do
 270     q = from u in User,
 271       where: u.follower_address in ^following,
 272       where: u.id != ^id
 273
 274     {:ok, Repo.all(q)}
 275   end
 276
 277   def increase_note_count(%User{} = user) do
 278     note_count = (user.info["note_count"] || 0) + 1
 279     new_info = Map.put(user.info, "note_count", note_count)
 280
 281     cs = info_changeset(user, %{info: new_info})
 282
 283     update_and_set_cache(cs)
 284   end
 285
 286   def update_note_count(%User{} = user) do
 287     note_count_query = from a in Object,
 288       where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
 289       select: count(a.id)
 290
 291     note_count = Repo.one(note_count_query)
 292
 293     new_info = Map.put(user.info, "note_count", note_count)
 294
 295     cs = info_changeset(user, %{info: new_info})
 296
 297     update_and_set_cache(cs)
 298   end
 299
 300   def update_follower_count(%User{} = user) do
 301     follower_count_query = from u in User,
 302       where: ^user.follower_address in u.following,
 303       where: u.id != ^user.id,
 304       select: count(u.id)
 305
 306     follower_count = Repo.one(follower_count_query)
 307
 308     new_info = Map.put(user.info, "follower_count", follower_count)
 309
 310     cs = info_changeset(user, %{info: new_info})
 311
 312     update_and_set_cache(cs)
 313   end
 314
 315   def get_notified_from_activity(%Activity{recipients: to}) do
 316     query = from u in User,
 317       where: u.ap_id in ^to,
 318       where: u.local == true
 319
 320     Repo.all(query)
 321   end
 322
 323   def get_recipients_from_activity(%Activity{recipients: to}) do
 324     query = from u in User,
 325       where: u.ap_id in ^to,
 326       or_where: fragment("? \\\?| ?", u.following, ^to)
 327
 328     query = from u in query,
 329       where: u.local == true
 330
 331     Repo.all(query)
 332   end
 333
 334   def search(query, resolve) do
 335     if resolve do
 336       User.get_or_fetch_by_nickname(query)
 337     end
 338     q = from u in User,
 339       where: fragment("(to_tsvector('english', ?) || to_tsvector('english', ?)) @@ plainto_tsquery('english', ?)", u.nickname, u.name, ^query),
 340       limit: 20
 341     Repo.all(q)
 342   end
 343
 344   def block(user, %{ap_id: ap_id}) do
 345     blocks = user.info["blocks"] || []
 346     new_blocks = Enum.uniq([ap_id | blocks])
 347     new_info = Map.put(user.info, "blocks", new_blocks)
 348
 349     cs = User.info_changeset(user, %{info: new_info})
 350     update_and_set_cache(cs)
 351   end
 352
 353   def unblock(user, %{ap_id: ap_id}) do
 354     blocks = user.info["blocks"] || []
 355     new_blocks = List.delete(blocks, ap_id)
 356     new_info = Map.put(user.info, "blocks", new_blocks)
 357
 358     cs = User.info_changeset(user, %{info: new_info})
 359     update_and_set_cache(cs)
 360   end
 361
 362   def blocks?(user, %{ap_id: ap_id}) do
 363     blocks = user.info["blocks"] || []
 364     Enum.member?(blocks, ap_id)
 365   end
 366
 367   def local_user_query() do
 368     from u in User,
 369       where: u.local == true
 370   end
 371
 372   def deactivate (%User{} = user) do
 373     new_info = Map.put(user.info, "deactivated", true)
 374     cs = User.info_changeset(user, %{info: new_info})
 375     update_and_set_cache(cs)
 376   end
 377
 378   def delete (%User{} = user) do
 379     {:ok, user} = User.deactivate(user)
 380
 381     # Remove all relationships
 382     {:ok, followers } = User.get_followers(user)
 383     followers
 384     |> Enum.each(fn (follower) -> User.unfollow(follower, user) end)
 385
 386     {:ok, friends} = User.get_friends(user)
 387     friends
 388     |> Enum.each(fn (followed) -> User.unfollow(user, followed) end)
 389
 390     query = from a in Activity,
 391       where: a.actor == ^user.ap_id
 392
 393     Repo.all(query)
 394     |> Enum.each(fn (activity) ->
 395       case activity.data["type"] do
 396         "Create" -> ActivityPub.delete(Object.get_by_ap_id(activity.data["object"]["id"]))
 397         _ -> "Doing nothing" # TODO: Do something with likes, follows, repeats.
 398       end
 399     end)
 400
 401     :ok
 402   end
 403
 404   def get_or_fetch_by_ap_id(ap_id) do
 405     if user = get_by_ap_id(ap_id) do
 406       user
 407     else
 408       with {:ok, user} <- ActivityPub.make_user_from_ap_id(ap_id) do
 409         user
 410       end
 411     end
 412   end
 413
 414   # AP style
 415   def public_key_from_info(%{"source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}}) do
 416      key = :public_key.pem_decode(public_key_pem)
 417      |> hd()
 418      |> :public_key.pem_entry_decode()
 419
 420      {:ok, key}
 421   end
 422
 423   # OStatus Magic Key
 424   def public_key_from_info(%{"magic_key" => magic_key}) do
 425     {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
 426   end
 427
 428   def get_public_key_for_ap_id(ap_id) do
 429     with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
 430          {:ok, public_key} <- public_key_from_info(user.info) do
 431       {:ok, public_key}
 432     else
 433       _ -> :error
 434     end
 435   end
 436
 437   defp blank?(""), do: nil
 438   defp blank?(n), do: n
 439
 440   def insert_or_update_user(data) do
 441     data = data
 442     |> Map.put(:name, blank?(data[:name]) || data[:nickname])
 443     cs = User.remote_user_creation(data)
 444     Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
 445   end
 446
 447   def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
 448 end