feat(immich): move restore user script to immich api and add find duplicate people function

This commit is contained in:
Lucas Vivo committed 2026-11-04 07:50:44 +01:00
1 parent 6018845525
commit ac1bbcda85
2 files changed
+161 -45

No files matched your search

+161
View File
@@ -0,0 +1,161 @@
#!/home/lucas/scripts/.venv/bin/python
from __future__ import annotations
from typing import Any
import requests
import logging
from serverlibrary import (
CustomLogger,
setup_logging,
)
logging.setLoggerClass(CustomLogger)
logger: CustomLogger = logging.getLogger(__name__) # type: ignore[assignment]
class ImmichAPI:
def __init__(self, url: str, api_key: str, timeout: int = 30) -> None:
self.url = url.rstrip("/")
self.timeout = timeout
self.session = requests.Session()
self.session.headers.update(
{
"x-api-key": api_key,
"Accept": "application/json",
}
)
def _request(
self,
method: str,
endpoint: str,
**kwargs: Any,
) -> Any:
logger.info(f"Sending request to '{self.url}{endpoint}'")
resp = self.session.request(
method,
f"{self.url}{endpoint}",
timeout=self.timeout,
**kwargs,
)
resp.raise_for_status()
if not resp.content:
return None
logger.trace(f"Received response {resp.content}'")
return resp.json()
# ------------------------------------------------------------------
# Users
# ------------------------------------------------------------------
def get_users(self, with_deleted: bool = False) -> list[dict[str, Any]]:
return self._request(
"GET",
"/admin/users",
params={"withDeleted": str(with_deleted).lower()},
)
def find_deleted_user(self, username: str) -> dict[str, Any] | None:
users = self.get_users(with_deleted=True)
return next(
(
user
for user in users
if user.get("name") == username
and user.get("status") == "deleted"
),
None,
)
def restore_user(self, username: str) -> bool:
user = self.find_deleted_user(username)
if not user:
logger.warning(f"No deleted user named '{username}' found")
return False
user_id = user["id"]
logger.info(f"Restoring user '{username}' ({user_id})")
self._request(
"POST",
f"/admin/users/{user_id}/restore",
)
logger.info(f"Restored user '{username}' ({user_id})")
return True
# ------------------------------------------------------------------
# People
# ------------------------------------------------------------------
def get_people(self) -> list[dict[str, Any]]:
return self._request("GET", "/people").get("people",[])
def get_person(self,id) -> list[dict[str, Any]]:
return self._request("GET", f"/people/{id}/statistics")
def delete_person(self, person_id: str) -> None:
self._request(
"DELETE",
f"/person/{person_id}",
)
def delete_empty_people(self) -> int:
deleted = 0
for person in self.get_people():
face_count = self.get_person(person["id"]).get("assets")
person_id = person["id"]
name = person.get("name") or "<unnamed>"
if not face_count:
logger.warning(f"ID {person['id']} has no face count")
if face_count != 0:
logger.debug(f"Found regular person {name} with {face_count} faces, ID: {person_id}")
continue
logger.info(
f"Deleting empty person "
f"'{name}' ({person_id})"
)
try:
self.delete_person(person_id)
deleted += 1
except requests.HTTPError as exc:
logger.error(
f"Failed to delete "
f"'{name}' ({person_id}): {exc}"
)
logger.info(f"Deleted {deleted} empty people")
return deleted
def find_duplicates(self):
people_list = []
for person in self.get_people():
name = person.get("name")
if name and name not in people_list:
people_list.append(name)
elif name and name in people_list:
logger.warning(f"Name {name} is duplicated")
def main() -> None:
IMMICH_URL = "https://fotos.someoneslinux.selfhost.eu/api"
API_KEY = "I0vEVKsx89rlPv50xp1ZvZfP5jgApRSOGC9uR5Ekzc"
setup_logging("debug","immich_logger")
api = ImmichAPI(
url=IMMICH_URL,
api_key=API_KEY,
)
#api.restore_user("Mimi")
#api.delete_empty_people()
api.find_duplicates()
if __name__ == "__main__":
main()
-45
View File
@@ -1,45 +0,0 @@
#!/home/lucas/scripts/.venv/bin/python
import requests
IMMICH_URL = "https://fotos.someoneslinux.selfhost.eu/api"
API_KEY = "I0vEVKsx89rlPv50xp1ZvZfP5jgApRSOGC9uR5Ekzc"
USERNAME = "Mimi"
headers = {
"x-api-key": API_KEY,
"Accept": "application/json",
}
# Find deleted user
resp = requests.get(
f"{IMMICH_URL}/admin/users",
headers=headers,
params={"withDeleted": "true"},
)
resp.raise_for_status()
users = resp.json()
user = next(
(u for u in users if u.get("name") == USERNAME and u.get("status") == "deleted"),
None,
)
if not user:
print(f"No deleted user named '{USERNAME}' found")
raise SystemExit(1)
user_id = user["id"]
print(f"Restore user {USERNAME}: {user_id}")
# Restore user
resp = requests.post(
f"{IMMICH_URL}/admin/users/{user_id}/restore",
headers=headers,
)
resp.raise_for_status()
print(f"Restored user '{USERNAME}' ({user_id})")