Packages
phoenix_kit
2.41.1
2.45.0
2.44.0
2.43.1
2.43.0
2.42.1
2.42.0
2.41.6
2.41.4
2.41.3
2.41.2
2.41.1
2.41.0
2.40.1
2.40.0
2.39.0
2.38.1
2.38.0
2.37.5
2.37.4
2.37.3
2.37.2
2.37.1
2.37.0
2.36.1
2.36.0
2.35.0
2.34.0
2.33.0
2.32.1
2.32.0
2.31.1
2.31.0
2.30.0
2.29.1
2.29.0
2.28.2
2.28.1
2.28.0
2.27.2
2.27.1
2.27.0
2.26.1
2.26.0
2.25.0
2.24.0
2.23.3
2.23.2
2.23.1
2.23.0
2.22.24
2.22.23
2.22.22
2.22.21
2.22.20
2.22.19
2.22.18
2.22.17
2.22.16
2.22.15
2.22.14
2.22.13
2.22.12
2.22.11
2.22.10
2.22.9
2.22.8
2.22.7
2.22.6
2.22.5
2.22.4
2.22.3
2.22.2
2.22.1
2.22.0
2.21.5
2.21.4
2.21.3
2.21.2
2.21.1
2.21.0
2.20.0
2.19.0
2.18.1
2.18.0
2.17.0
2.16.0
2.15.1
2.15.0
2.14.2
2.14.1
2.14.0
2.13.19
2.13.18
2.13.17
2.13.16
2.13.15
2.13.13
2.13.12
2.13.11
2.13.10
2.13.9
2.13.8
2.13.7
2.13.6
2.13.5
2.13.4
2.13.3
2.13.2
2.13.1
2.13.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.1
2.8.0
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.0
2.1.0
2.0.1
2.0.0
1.7.236
1.7.235
1.7.234
1.7.233
1.7.232
1.7.231
1.7.230
1.7.229
1.7.228
1.7.227
1.7.226
1.7.225
1.7.224
1.7.223
1.7.222
1.7.221
1.7.220
1.7.219
1.7.218
1.7.217
1.7.216
1.7.215
1.7.214
1.7.213
1.7.212
1.7.211
1.7.210
1.7.209
1.7.208
1.7.207
1.7.206
1.7.205
1.7.204
1.7.203
1.7.202
1.7.201
1.7.200
1.7.199
1.7.198
1.7.197
1.7.196
1.7.194
1.7.193
1.7.192
1.7.191
1.7.190
1.7.189
1.7.187
1.7.186
1.7.185
1.7.184
1.7.183
1.7.182
1.7.181
1.7.180
1.7.179
1.7.178
1.7.177
1.7.176
1.7.175
1.7.174
1.7.173
1.7.172
1.7.171
1.7.170
1.7.169
1.7.168
1.7.167
1.7.166
1.7.165
1.7.164
1.7.162
1.7.161
1.7.160
1.7.159
1.7.157
1.7.156
1.7.155
1.7.154
1.7.153
1.7.152
1.7.151
1.7.150
1.7.149
1.7.146
1.7.145
1.7.144
1.7.143
1.7.138
1.7.133
1.7.132
1.7.131
1.7.130
1.7.128
1.7.126
1.7.125
1.7.121
1.7.120
1.7.119
1.7.118
1.7.117
1.7.116
1.7.115
1.7.114
1.7.113
1.7.112
1.7.111
1.7.110
1.7.109
1.7.108
1.7.107
1.7.106
1.7.105
1.7.104
1.7.103
1.7.102
1.7.101
1.7.100
1.7.99
1.7.98
1.7.97
1.7.96
1.7.95
1.7.94
1.7.93
1.7.92
1.7.91
1.7.90
1.7.89
1.7.88
1.7.87
1.7.86
1.7.85
1.7.84
1.7.83
1.7.82
1.7.81
1.7.80
1.7.79
1.7.78
1.7.77
1.7.76
1.7.75
1.7.74
1.7.71
1.7.70
1.7.69
1.7.66
1.7.65
1.7.64
1.7.63
1.7.62
1.7.61
1.7.59
1.7.58
1.7.57
1.7.56
1.7.55
1.7.54
1.7.53
1.7.52
1.7.51
1.7.49
1.7.44
1.7.43
1.7.42
1.7.41
1.7.39
1.7.38
1.7.37
1.7.36
1.7.34
1.7.33
1.7.31
1.7.30
1.7.29
1.7.28
1.7.27
1.7.26
1.7.25
1.7.24
1.7.23
1.7.22
1.7.21
1.7.20
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.20
1.6.19
1.6.18
1.6.17
1.6.16
1.6.15
1.6.14
1.6.13
1.6.12
1.6.11
1.6.10
1.6.9
1.6.8
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.5.2
1.5.1
1.5.0
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.2
1.3.1
1.3.0
1.2.10
1.2.9
1.2.8
1.2.7
1.2.5
1.2.4
1.2.2
1.2.1
1.2.0
1.1.0
1.0.0
A foundation for building Elixir Phoenix apps — SaaS, social networks, ERP systems, marketplaces, and more
Current section
Files
Jump to
Current section
Files
lib/modules/storage/profiles.ex
defmodule PhoenixKit.Modules.Storage.Profiles do
@moduledoc """
Storage profiles: where a library's bytes live (V205).
A library points at a profile (`PhoenixKit.Modules.Storage.StorageProfile`),
and the profile lists its buckets with how it uses each
(`PhoenixKit.Modules.Storage.ProfileBucket`: role, what it stores, write
priority, serve order, status) and how many copies an object gets. A
library with no profile uses the **Default**, seeded by V205 from the
install's buckets and `storage_redundancy_copies` under a fixed uuid
(`default_uuid/0`), so an install that never touches profiles behaves as
it did before.
Every change to a profile or its buckets bumps its `revision`
(`bump_revision/1`). A file records the profile and revision it was
placed by (`placed_profile_uuid` / `placed_revision`, NULL meaning the
Default at revision 1), which is how the reconciler finds the files that
are not where their library's profile wants them.
"""
import Ecto.Query
alias PhoenixKit.Modules.Storage.File, as: StorageFile
alias PhoenixKit.Modules.Storage.Libraries
alias PhoenixKit.Modules.Storage.{Library, ProfileBucket, StorageProfile}
alias PhoenixKit.Modules.Storage.Workers.ReconcileJob
alias PhoenixKit.Settings
@default_uuid "00000000-0000-7000-8000-000000000002"
@doc "The uuid of the Default profile, fixed on every install."
@spec default_uuid() :: String.t()
def default_uuid, do: @default_uuid
@doc "Whether `uuid` is the Default profile's."
@spec default?(term()) :: boolean()
def default?(%StorageProfile{uuid: uuid}), do: default?(uuid)
def default?(uuid), do: to_string(uuid) == @default_uuid
@doc "Every profile, the Default first, each with its buckets."
@spec list_profiles() :: [StorageProfile.t()]
def list_profiles do
from(p in StorageProfile, order_by: [desc: p.is_default, asc: fragment("lower(?)", p.name)])
|> repo().all()
|> preload_buckets()
end
@doc "A profile with its buckets, or nil (also for anything not a uuid)."
@spec get_profile(term()) :: StorageProfile.t() | nil
def get_profile(uuid) do
with {:ok, uuid} <- Ecto.UUID.cast(uuid),
%StorageProfile{} = profile <- repo().get(StorageProfile, uuid) do
preload_buckets(profile)
else
_ -> nil
end
end
@doc "The Default profile, with its buckets."
@spec default_profile() :: StorageProfile.t() | nil
def default_profile, do: get_profile(@default_uuid)
@doc """
How many copies of an original the Default keeps (1 when there is no
Default yet, as `storage_redundancy_copies` defaulted to).
"""
@spec default_copies() :: pos_integer()
def default_copies do
from(p in StorageProfile, where: p.uuid == ^@default_uuid, select: p.copies_originals)
|> repo().one() || 1
end
@doc """
The uuid of the profile `library` uses: its own, or the Default. Takes a
library, a library uuid, or nil (a file with no library is in Media).
"""
@spec profile_uuid_for(Library.t() | term()) :: String.t()
def profile_uuid_for(%Library{storage_profile_uuid: nil}), do: @default_uuid
def profile_uuid_for(%Library{storage_profile_uuid: uuid}), do: to_string(uuid)
def profile_uuid_for(nil), do: profile_uuid_for(Libraries.media_uuid())
def profile_uuid_for(library_uuid) do
case Libraries.get_library(library_uuid) do
%Library{} = library -> profile_uuid_for(library)
nil -> @default_uuid
end
end
@doc """
The profile `library` uses, with its buckets (see `profile_uuid_for/1`).
Falls back to the Default when the library's own is gone.
"""
@spec for_library(Library.t() | term()) :: StorageProfile.t() | nil
def for_library(library) do
library |> profile_uuid_for() |> get_profile() || default_profile()
end
@doc "The profile a file's library uses."
@spec for_file(StorageFile.t()) :: StorageProfile.t() | nil
def for_file(%StorageFile{library_uuid: library_uuid}), do: for_library(library_uuid)
@doc """
The number of copies `profile` wants of an object: `:original` for an
original upload, `:derived` for anything made from one.
"""
@spec copies(StorageProfile.t(), :original | :derived) :: pos_integer()
def copies(%StorageProfile{copies_originals: n}, :original), do: n
def copies(%StorageProfile{copies_variants: n}, :derived), do: n
@doc "Creates a profile with no buckets."
@spec create_profile(map()) :: {:ok, StorageProfile.t()} | {:error, Ecto.Changeset.t()}
def create_profile(attrs) do
%StorageProfile{}
|> StorageProfile.changeset(attrs)
|> repo().insert()
|> case do
{:ok, profile} -> {:ok, preload_buckets(profile)}
error -> error
end
end
@doc "Updates a profile's name or copy counts; a real change bumps its revision."
@spec update_profile(StorageProfile.t(), map()) ::
{:ok, StorageProfile.t()} | {:error, Ecto.Changeset.t()}
def update_profile(%StorageProfile{} = profile, attrs) do
changeset = StorageProfile.changeset(profile, attrs)
transact(fn ->
with {:ok, updated} <- repo().update(changeset) do
if placement_changed?(changeset), do: bump_revision(updated.uuid)
{:ok, updated.uuid}
end
end)
|> reload()
end
# A rename moves no bytes, and neither does how many copies an upload
# needs (it applies to the next upload): neither makes every file stale.
defp placement_changed?(changeset),
do: Map.drop(changeset.changes, [:name, :min_copies_on_write]) != %{}
@doc """
Deletes a profile. The Default cannot be deleted
(`{:error, :default}`), nor a profile a library uses
(`{:error, :in_use}`).
"""
@spec delete_profile(StorageProfile.t()) ::
{:ok, StorageProfile.t()} | {:error, :default | :in_use | Ecto.Changeset.t()}
def delete_profile(%StorageProfile{} = profile) do
cond do
default?(profile) ->
{:error, :default}
libraries_using(profile.uuid) > 0 ->
{:error, :in_use}
true ->
profile
|> Ecto.Changeset.change()
|> Ecto.Changeset.foreign_key_constraint(:uuid,
name: :phoenix_kit_storage_libraries_profile_fkey,
message: "is used by a library"
)
|> repo().delete()
end
end
@doc "How many libraries (trashed ones included) use `profile_uuid` explicitly."
@spec libraries_using(term()) :: non_neg_integer()
def libraries_using(profile_uuid) do
from(l in Library, where: l.storage_profile_uuid == ^profile_uuid, select: count())
|> repo().one()
end
@doc """
Adds `bucket_uuid` to `profile`, or changes how the profile uses it, and
bumps the profile's revision.
"""
@spec put_bucket(StorageProfile.t(), term(), map()) ::
{:ok, ProfileBucket.t()} | {:error, Ecto.Changeset.t()}
def put_bucket(%StorageProfile{uuid: profile_uuid}, bucket_uuid, attrs) do
row =
repo().get_by(ProfileBucket, profile_uuid: profile_uuid, bucket_uuid: bucket_uuid) ||
%ProfileBucket{profile_uuid: profile_uuid, bucket_uuid: bucket_uuid}
changeset = ProfileBucket.changeset(row, attrs)
transact(fn ->
with {:ok, saved} <- repo().insert_or_update(changeset) do
if row.__meta__.state == :built or moves_bytes?(changeset),
do: bump_revision(profile_uuid)
{:ok, saved}
end
end)
end
# What a file's placement depends on: what a bucket stores, its status,
# and its role (a file needs a copy it may serve). The serve order is read
# when a request is served, and a write priority or storage class only
# applies to the next write: changing them makes no file stale.
defp moves_bytes?(changeset),
do: Map.take(changeset.changes, [:stores, :status, :role]) != %{}
@doc "Takes `bucket_uuid` out of `profile` and bumps the profile's revision."
@spec remove_bucket(StorageProfile.t(), term()) :: :ok
def remove_bucket(%StorageProfile{uuid: profile_uuid}, bucket_uuid) do
{:ok, :ok} =
transact(fn ->
{count, _} =
from(r in ProfileBucket,
where: r.profile_uuid == ^profile_uuid and r.bucket_uuid == ^bucket_uuid
)
|> repo().delete_all()
if count > 0, do: bump_revision(profile_uuid)
{:ok, :ok}
end)
:ok
end
@doc """
Puts a newly created bucket into the Default profile, the way every new
bucket joined the pool before profiles: primary, stores everything,
active, its `priority` as the write priority (0 is the shuffled pool),
served after the Default's other buckets (a local one before the remote
ones).
"""
@spec add_to_default(PhoenixKit.Modules.Storage.Bucket.t()) :: :ok
def add_to_default(bucket) do
serve_order =
from(r in ProfileBucket,
where: r.profile_uuid == ^@default_uuid,
select: coalesce(max(r.serve_order), 0)
)
|> repo().one()
# Profiles are seeded by V205; before that (or on a database repair has
# not reached yet) there is no Default to add to.
if repo().get(StorageProfile, @default_uuid) do
{:ok, _} =
put_bucket(%StorageProfile{uuid: @default_uuid}, bucket.uuid, %{
role: "primary",
stores: "all",
status: "active",
write_priority: write_priority(bucket.priority),
serve_order: serve_order + 1
})
end
:ok
end
@doc false
# A bucket's `priority` as a profile's write priority: 0 was "the
# shuffled pool", which is `nil` here.
def write_priority(priority) when is_integer(priority) and priority > 0, do: priority
def write_priority(_priority), do: nil
@doc """
Takes `bucket_uuid` out of every profile, bumping each one's revision.
Called when an empty bucket is deleted.
"""
@spec remove_bucket_everywhere(term()) :: :ok
def remove_bucket_everywhere(bucket_uuid) do
{:ok, :ok} =
transact(fn ->
{_count, profile_uuids} =
from(r in ProfileBucket, where: r.bucket_uuid == ^bucket_uuid, select: r.profile_uuid)
|> repo().delete_all()
Enum.each(Enum.uniq(profile_uuids), &bump_revision/1)
{:ok, :ok}
end)
:ok
end
@doc """
Points `library` at `profile_uuid` (nil for the Default). Its files
become stale unless the new profile is the one they were placed by.
"""
@spec set_library_profile(Library.t(), term()) ::
{:ok, Library.t()} | {:error, Ecto.Changeset.t() | :not_found}
def set_library_profile(%Library{} = library, profile_uuid) do
profile_uuid = if default?(profile_uuid), do: nil, else: profile_uuid
if profile_uuid && is_nil(get_profile(profile_uuid)) do
{:error, :not_found}
else
library
|> Ecto.Changeset.change(storage_profile_uuid: profile_uuid)
|> Ecto.Changeset.foreign_key_constraint(:storage_profile_uuid,
name: :phoenix_kit_storage_libraries_profile_fkey
)
|> repo().update()
|> tap(&if(match?({:ok, _}, &1), do: ReconcileJob.enqueue()))
end
end
@doc """
Bumps a profile's revision: every file it placed is stale, and the
reconciler is queued to bring them up to date.
"""
@spec bump_revision(term()) :: :ok
def bump_revision(profile_uuid) do
from(p in StorageProfile, where: p.uuid == ^profile_uuid)
|> repo().update_all(
inc: [revision: 1],
set: [updated_at: DateTime.truncate(DateTime.utc_now(), :second)]
)
ReconcileJob.enqueue()
:ok
end
defp preload_buckets(profile_or_profiles) do
rows = from(r in ProfileBucket, order_by: [asc: r.serve_order, asc: r.inserted_at])
repo().preload(profile_or_profiles, buckets: {rows, :bucket})
end
defp reload({:ok, uuid}) do
profile = get_profile(uuid)
# The Default's copy count is what `storage_redundancy_copies` was; the
# row is kept in step for code that still reads it.
if profile.is_default,
do:
Settings.update_setting("storage_redundancy_copies", to_string(profile.copies_originals))
{:ok, profile}
end
defp reload(error), do: error
defp transact(fun) do
repo().transaction(fn ->
case fun.() do
{:ok, value} -> value
{:error, reason} -> repo().rollback(reason)
end
end)
end
defp repo, do: PhoenixKit.RepoHelper.repo()
end