Merge pull request 'Update dependency fastapi to v0.103.0' (#29) from renovate/fastapi-0.x into dev

Reviewed-on: #29

classes/exceptions.py

@@ -164,6 +164,26 @@ class VideoSearchQueryEmptyError(HTTPException):
         )
 
 
+class SearchLimitInvalidError(HTTPException):
+    """Raises HTTP 400 if search results limit not in valid range."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Limit",
+            "content": {
+                "application/json": {
+                    "example": {
+                        "detail": "Parameter 'limit' must be greater or equal to 1."
+                    }
+                }
+            },
+        }
+        super().__init__(
+            status_code=400,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
 class SearchPageInvalidError(HTTPException):
     """Raises HTTP 400 if page or page size are not in valid range."""
 

classes/models.py

@@ -72,3 +72,11 @@ class SearchResultsPhoto(BaseModel):
 class SearchResultsVideo(BaseModel):
     results: List[VideoSearch]
     next_page: Union[str, None]
+
+
+class RandomSearchResultsPhoto(BaseModel):
+    results: List[PhotoSearch]
+
+
+class RandomSearchResultsVideo(BaseModel):
+    results: List[VideoSearch]

extensions/albums.py

@@ -47,12 +47,12 @@ async def album_create(
     if 2 > len(title) > 40:
         raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
 
-    if col_albums.find_one({"name": name}) is not None:
+    if (await col_albums.find_one({"name": name})) is not None:
         raise AlbumAlreadyExistsError(name)
 
     makedirs(Path(f"data/users/{current_user.user}/albums/{name}"), exist_ok=True)
 
-    uploaded = col_albums.insert_one(
+    uploaded = await col_albums.insert_one(
         {"user": current_user.user, "name": name, "title": title, "cover": None}
     )
 
@@ -67,9 +67,10 @@ async def album_find(
     current_user: User = Security(get_current_active_user, scopes=["albums.list"]),
 ):
     output = {"results": []}
-    albums = list(col_albums.find({"user": current_user.user, "name": re.compile(q)}))
 
-    for album in albums:
+    async for album in col_albums.find(
+        {"user": current_user.user, "name": re.compile(q)}
+    ):
         output["results"].append(
             {
                 "id": album["_id"].__str__(),
@@ -102,18 +103,18 @@ async def album_patch(
     current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
 ):
     try:
-        album = col_albums.find_one({"_id": ObjectId(id)})
+        album = await col_albums.find_one({"_id": ObjectId(id)})
         if album is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise AlbumNotFoundError(id)
+        raise AlbumNotFoundError(id) from exc
 
-    if title is not None:
+    if title is None:
-        if 2 > len(title) > 40:
-            raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
-    else:
         title = album["title"]
 
+    elif 2 > len(title) > 40:
+        raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
+
     if name is not None:
         if re.search(re.compile("^[a-z,0-9,_]*$"), name) is False:
             raise AlbumIncorrectError(
@@ -125,7 +126,7 @@ async def album_patch(
             Path(f"data/users/{current_user.user}/albums/{album['name']}"),
             Path(f"data/users/{current_user.user}/albums/{name}"),
         )
-        col_photos.update_many(
+        await col_photos.update_many(
             {"user": current_user.user, "album": album["name"]},
             {"$set": {"album": name}},
         )
@@ -133,12 +134,14 @@ async def album_patch(
         name = album["name"]
 
     if cover is not None:
-        image = col_photos.find_one({"_id": ObjectId(cover), "album": album["name"]})
+        image = await col_photos.find_one(
+            {"_id": ObjectId(cover), "album": album["name"]}
+        )
         cover = image["_id"].__str__() if image is not None else album["cover"]
     else:
         cover = album["cover"]
 
-    col_albums.update_one(
+    await col_albums.update_one(
         {"_id": ObjectId(id)}, {"$set": {"name": name, "title": title, "cover": cover}}
     )
 
@@ -166,11 +169,11 @@ async def album_put(
     current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
 ):
     try:
-        album = col_albums.find_one({"_id": ObjectId(id)})
+        album = await col_albums.find_one({"_id": ObjectId(id)})
         if album is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise AlbumNotFoundError(id)
+        raise AlbumNotFoundError(id) from exc
 
     if re.search(re.compile("^[a-z,0-9,_]*$"), name) is False:
         raise AlbumIncorrectError("name", "can only contain a-z, 0-9 and _ characters.")
@@ -181,7 +184,7 @@ async def album_put(
     if 2 > len(title) > 40:
         raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
 
-    image = col_photos.find_one({"_id": ObjectId(cover), "album": album["name"]})
+    image = await col_photos.find_one({"_id": ObjectId(cover), "album": album["name"]})
     cover = image["_id"].__str__() if image is not None else None  # type: ignore
 
     rename(
@@ -189,10 +192,10 @@ async def album_put(
         Path(f"data/users/{current_user.user}/albums/{name}"),
     )
 
-    col_photos.update_many(
+    await col_photos.update_many(
         {"user": current_user.user, "album": album["name"]}, {"$set": {"album": name}}
     )
-    col_albums.update_one(
+    await col_albums.update_one(
         {"_id": ObjectId(id)}, {"$set": {"name": name, "title": title, "cover": cover}}
     )
 
@@ -213,13 +216,13 @@ async def album_delete(
     current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
 ):
     try:
-        album = col_albums.find_one_and_delete({"_id": ObjectId(id)})
+        album = await col_albums.find_one_and_delete({"_id": ObjectId(id)})
         if album is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise AlbumNotFoundError(id)
+        raise AlbumNotFoundError(id) from exc
 
-    col_photos.delete_many({"album": album["name"]})
+    await col_photos.delete_many({"album": album["name"]})
 
     rmtree(Path(f"data/users/{current_user.user}/albums/{album['name']}"))
 

extensions/photos.py

@@ -3,6 +3,7 @@ import re
 from datetime import datetime, timedelta, timezone
 from os import makedirs, path, remove, system
 from pathlib import Path
+from random import randint
 from secrets import token_urlsafe
 from shutil import move
 from threading import Thread
@@ -26,10 +27,16 @@ from classes.exceptions import (
     AlbumNameNotFoundError,
     PhotoNotFoundError,
     PhotoSearchQueryEmptyError,
+    SearchLimitInvalidError,
     SearchPageInvalidError,
     SearchTokenInvalidError,
 )
-from classes.models import Photo, PhotoPublic, SearchResultsPhoto
+from classes.models import (
+    Photo,
+    PhotoPublic,
+    RandomSearchResultsPhoto,
+    SearchResultsPhoto,
+)
 from modules.app import app
 from modules.database import col_albums, col_photos, col_tokens
 from modules.exif_reader import extract_location
@@ -115,7 +122,7 @@ async def photo_upload(
     caption: Union[str, None] = None,
     current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
 ):
-    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+    if (await col_albums.find_one({"user": current_user.user, "name": album})) is None:
         raise AlbumNameNotFoundError(album)
 
     makedirs(Path(f"data/users/{current_user.user}/albums/{album}"), exist_ok=True)
@@ -139,11 +146,9 @@ async def photo_upload(
     )
     duplicates = await get_duplicates(file_hash, album)
 
-    if len(duplicates) > 0 and ignore_duplicates is False:
+    if len(duplicates) > 0 and not ignore_duplicates:
         if configGet("media_token_access") is True:
-            duplicates_ids = []
+            duplicates_ids = [entry["id"] for entry in duplicates]
-            for entry in duplicates:
-                duplicates_ids.append(entry["id"])
             access_token = create_access_token(
                 data={
                     "sub": current_user.user,
@@ -153,7 +158,7 @@ async def photo_upload(
                 expires_delta=timedelta(hours=configGet("media_token_valid_hours")),
             )
             access_token_short = uuid4().hex[:12].lower()
-            col_tokens.insert_one(
+            await col_tokens.insert_one(
                 {
                     "short": access_token_short,
                     "access_token": access_token,
@@ -178,7 +183,7 @@ async def photo_upload(
     except (UnpackError, ValueError):
         coords = {"lng": 0.0, "lat": 0.0, "alt": 0.0}
 
-    uploaded = col_photos.insert_one(
+    uploaded = await col_photos.insert_one(
         {
             "user": current_user.user,
             "album": album,
@@ -193,7 +198,7 @@ async def photo_upload(
         }
     )
 
-    if compress is True:
+    if compress:
         scheduler.add_job(
             compress_image,
             trigger="date",
@@ -226,7 +231,7 @@ if configGet("media_token_access") is True:
         responses=photo_get_token_responses,
     )
     async def photo_get_token(token: str, id: int):
-        db_entry = col_tokens.find_one({"short": token})
+        db_entry = await col_tokens.find_one({"short": token})
 
         if db_entry is None:
             raise AccessTokenInvalidError()
@@ -241,24 +246,23 @@ if configGet("media_token_access") is True:
                 raise AccessTokenInvalidError()
             token_scopes = payload.get("scopes", [])
             token_data = TokenData(scopes=token_scopes, user=user)
-        except (JWTError, ValidationError) as exp:
+        except (JWTError, ValidationError) as exc:
-            print(exp, flush=True)
+            raise AccessTokenInvalidError() from exc
-            raise AccessTokenInvalidError()
 
-        user = get_user(user=token_data.user)
+        user_record = await get_user(user=token_data.user)
 
         if id not in payload.get("allowed", []):
             raise AccessTokenInvalidError()
 
         try:
-            image = col_photos.find_one({"_id": ObjectId(id)})
+            image = await col_photos.find_one({"_id": ObjectId(id)})
             if image is None:
                 raise InvalidId(id)
-        except InvalidId:
+        except InvalidId as exc:
-            raise PhotoNotFoundError(id)
+            raise PhotoNotFoundError(id) from exc
 
         image_path = Path(
-            f"data/users/{user.user}/albums/{image['album']}/{image['filename']}"
+            f"data/users/{user_record.user}/albums/{image['album']}/{image['filename']}"
         )
 
         mime = Magic(mime=True).from_file(image_path)
@@ -296,11 +300,11 @@ async def photo_get(
     current_user: User = Security(get_current_active_user, scopes=["photos.read"]),
 ):
     try:
-        image = col_photos.find_one({"_id": ObjectId(id)})
+        image = await col_photos.find_one({"_id": ObjectId(id)})
         if image is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise PhotoNotFoundError(id)
+        raise PhotoNotFoundError(id) from exc
 
     image_path = Path(
         f"data/users/{current_user.user}/albums/{image['album']}/{image['filename']}"
@@ -329,13 +333,13 @@ async def photo_move(
     current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
 ):
     try:
-        image = col_photos.find_one({"_id": ObjectId(id)})
+        image = await col_photos.find_one({"_id": ObjectId(id)})
         if image is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise PhotoNotFoundError(id)
+        raise PhotoNotFoundError(id) from exc
 
-    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+    if (await col_albums.find_one({"user": current_user.user, "name": album})) is None:
         raise AlbumNameNotFoundError(album)
 
     if Path(
@@ -349,7 +353,7 @@ async def photo_move(
     else:
         filename = image["filename"]
 
-    col_photos.find_one_and_update(
+    await col_photos.find_one_and_update(
         {"_id": ObjectId(id)},
         {
             "$set": {
@@ -391,13 +395,13 @@ async def photo_patch(
     current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
 ):
     try:
-        image = col_photos.find_one({"_id": ObjectId(id)})
+        image = await col_photos.find_one({"_id": ObjectId(id)})
         if image is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise PhotoNotFoundError(id)
+        raise PhotoNotFoundError(id) from exc
 
-    col_photos.find_one_and_update(
+    await col_photos.find_one_and_update(
         {"_id": ObjectId(id)},
         {"$set": {"caption": caption, "dates.modified": datetime.now(tz=timezone.utc)}},
     )
@@ -425,16 +429,16 @@ async def photo_delete(
     current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
 ):
     try:
-        image = col_photos.find_one_and_delete({"_id": ObjectId(id)})
+        image = await col_photos.find_one_and_delete({"_id": ObjectId(id)})
         if image is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise PhotoNotFoundError(id)
+        raise PhotoNotFoundError(id) from exc
 
-    album = col_albums.find_one({"name": image["album"]})
+    album = await col_albums.find_one({"name": image["album"]})
 
     if album is not None and album["cover"] == image["_id"].__str__():
-        col_albums.update_one({"name": image["album"]}, {"$set": {"cover": None}})
+        await col_albums.update_one({"name": image["album"]}, {"$set": {"cover": None}})
 
     remove(
         Path(
@@ -445,6 +449,67 @@ async def photo_delete(
     return Response(status_code=HTTP_204_NO_CONTENT)
 
 
+photo_random_responses = {
+    400: SearchLimitInvalidError().openapi,
+    404: AlbumNameNotFoundError("name").openapi,
+}
+
+
+@app.get(
+    "/albums/{album}/photos/random",
+    description="Get one random photo, optionally by caption",
+    response_class=UJSONResponse,
+    response_model=RandomSearchResultsPhoto,
+    responses=photo_random_responses,
+)
+async def photo_random(
+    album: str,
+    caption: Union[str, None] = None,
+    limit: int = 100,
+    current_user: User = Security(get_current_active_user, scopes=["photos.list"]),
+):
+    if (await col_albums.find_one({"user": current_user.user, "name": album})) is None:
+        raise AlbumNameNotFoundError(album)
+
+    if limit <= 0:
+        raise SearchLimitInvalidError()
+
+    output = {"results": []}
+
+    db_query = (
+        {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+        if caption is not None
+        else {
+            "user": current_user.user,
+            "album": album,
+        }
+    )
+
+    documents_count = await col_photos.count_documents(db_query)
+    skip = randint(0, documents_count - 1) if documents_count > 1 else 0
+
+    async for image in col_photos.aggregate(
+        [
+            {"$match": db_query},
+            {"$skip": skip},
+            {"$limit": limit},
+        ]
+    ):
+        output["results"].append(
+            {
+                "id": image["_id"].__str__(),
+                "filename": image["filename"],
+                "caption": image["caption"],
+            }
+        )
+
+    return UJSONResponse(output)
+
+
 photo_find_responses = {
     400: SearchPageInvalidError().openapi,
     401: SearchTokenInvalidError().openapi,
@@ -473,7 +538,7 @@ async def photo_find(
     current_user: User = Security(get_current_active_user, scopes=["photos.list"]),
 ):
     if token is not None:
-        found_record = col_tokens.find_one({"token": token})
+        found_record = await col_tokens.find_one({"token": token})
 
         if found_record is None:
             raise SearchTokenInvalidError()
@@ -490,7 +555,7 @@ async def photo_find(
             current_user=current_user,
         )
 
-    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+    if (await col_albums.find_one({"user": current_user.user, "name": album})) is None:
         raise AlbumNameNotFoundError(album)
 
     if page <= 0 or page_size <= 0:
@@ -519,7 +584,7 @@ async def photo_find(
         }
     elif q is None and caption is None:
         raise PhotoSearchQueryEmptyError()
-    elif q is None and caption is not None:
+    elif q is None:
         db_query = {
             "user": current_user.user,
             "album": album,
@@ -530,7 +595,7 @@ async def photo_find(
             "album": album,
             "caption": re.compile(caption),
         }
-    elif q is not None and caption is None:
+    elif caption is None:
         db_query = {
             "user": current_user.user,
             "album": album,
@@ -542,16 +607,22 @@ async def photo_find(
             "filename": re.compile(q),
         }
     else:
-        db_query = {"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}  # type: ignore
+        db_query = {
-        db_query_count = {"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}  # type: ignore
+            "user": current_user.user,
+            "album": album,
+            "filename": re.compile(q),
+            "caption": re.compile(caption),
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "filename": re.compile(q),
+            "caption": re.compile(caption),
+        }
 
-    images = list(
+    async for image in col_photos.find(db_query, limit=page_size, skip=skip).sort(
-        col_photos.find(db_query, limit=page_size, skip=skip).sort(
+        "dates.uploaded", direction=DESCENDING
-            "dates.uploaded", DESCENDING
+    ):
-        )
-    )
-
-    for image in images:
         output["results"].append(
             {
                 "id": image["_id"].__str__(),
@@ -560,9 +631,9 @@ async def photo_find(
             }
         )
 
-    if col_photos.count_documents(db_query_count) > page * page_size:
+    if (await col_photos.count_documents(db_query_count)) > page * page_size:
         token = str(token_urlsafe(32))
-        col_tokens.insert_one(
+        await col_tokens.insert_one(
             {
                 "token": token,
                 "query": q,

extensions/security.py

@@ -17,7 +17,7 @@ token_post_responses = {401: UserCredentialsInvalid().openapi}
 
 @app.post("/token", response_model=Token, responses=token_post_responses)
 async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
-    user = authenticate_user(form_data.username, form_data.password)
+    user = await authenticate_user(form_data.username, form_data.password)
     if not user:
         raise UserCredentialsInvalid()
     access_token_expires = timedelta(days=ACCESS_TOKEN_EXPIRE_DAYS)

extensions/users.py

@@ -41,14 +41,14 @@ async def send_confirmation(user: str, email: str):
                 + f"/users/{user}/confirm?code={confirmation_code}"
             ),
         )
-        col_emails.insert_one(
+        await col_emails.insert_one(
             {"user": user, "email": email, "used": False, "code": confirmation_code}
         )
         logger.info(
             "Sent confirmation email to '%s' with code %s", email, confirmation_code
         )
-    except Exception as exp:
+    except Exception as exc:
-        logger.error("Could not send confirmation email to '%s' due to: %s", email, exp)
+        logger.error("Could not send confirmation email to '%s' due to: %s", email, exc)
 
 
 @app.get("/users/me/", response_model=User)
@@ -80,15 +80,15 @@ if configGet("registration_requires_confirmation") is True:
         responses=user_confirm_responses,
     )
     async def user_confirm(user: str, code: str):
-        confirm_record = col_emails.find_one(
+        confirm_record = await col_emails.find_one(
             {"user": user, "code": code, "used": False}
         )
         if confirm_record is None:
             raise UserEmailCodeInvalid()
-        col_emails.find_one_and_update(
+        await col_emails.find_one_and_update(
             {"_id": confirm_record["_id"]}, {"$set": {"used": True}}
         )
-        col_users.find_one_and_update(
+        await col_users.find_one_and_update(
             {"user": confirm_record["user"]}, {"$set": {"disabled": False}}
         )
         return UJSONResponse({"detail": configGet("email_confirmed", "messages")})
@@ -103,9 +103,9 @@ if configGet("registration_enabled") is True:
     async def user_create(
         user: str = Form(), email: str = Form(), password: str = Form()
     ):
-        if col_users.find_one({"user": user}) is not None:
+        if (await col_users.find_one({"user": user})) is not None:
             raise UserAlreadyExists()
-        col_users.insert_one(
+        await col_users.insert_one(
             {
                 "user": user,
                 "email": email,
@@ -132,14 +132,14 @@ user_delete_responses = {401: UserCredentialsInvalid().openapi}
 async def user_delete(
     password: str = Form(), current_user: User = Depends(get_current_active_user)
 ):
-    user = get_user(current_user.user)
+    user = await get_user(current_user.user)
     if not user:
         return False
     if not verify_password(password, user.hash):
         raise UserCredentialsInvalid()
-    col_users.delete_many({"user": current_user.user})
+    await col_users.delete_many({"user": current_user.user})
-    col_emails.delete_many({"user": current_user.user})
+    await col_emails.delete_many({"user": current_user.user})
-    col_photos.delete_many({"user": current_user.user})
+    await col_photos.delete_many({"user": current_user.user})
-    col_videos.delete_many({"user": current_user.user})
+    await col_videos.delete_many({"user": current_user.user})
-    col_albums.delete_many({"user": current_user.user})
+    await col_albums.delete_many({"user": current_user.user})
     return Response(status_code=HTTP_204_NO_CONTENT)

extensions/videos.py

@@ -2,6 +2,7 @@ import re
 from datetime import datetime, timezone
 from os import makedirs, remove
 from pathlib import Path
+from random import randint
 from secrets import token_urlsafe
 from shutil import move
 from typing import Union
@@ -17,12 +18,18 @@ from starlette.status import HTTP_204_NO_CONTENT
 
 from classes.exceptions import (
     AlbumNameNotFoundError,
+    SearchLimitInvalidError,
     SearchPageInvalidError,
     SearchTokenInvalidError,
     VideoNotFoundError,
     VideoSearchQueryEmptyError,
 )
-from classes.models import SearchResultsVideo, Video, VideoPublic
+from classes.models import (
+    RandomSearchResultsVideo,
+    SearchResultsVideo,
+    Video,
+    VideoPublic,
+)
 from modules.app import app
 from modules.database import col_albums, col_tokens, col_videos
 from modules.security import User, get_current_active_user
@@ -43,7 +50,7 @@ async def video_upload(
     caption: Union[str, None] = None,
     current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
 ):
-    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+    if (await col_albums.find_one({"user": current_user.user, "name": album})) is None:
         raise AlbumNameNotFoundError(album)
 
     makedirs(Path(f"data/users/{current_user.user}/albums/{album}"), exist_ok=True)
@@ -66,7 +73,7 @@ async def video_upload(
 
     # Coords extraction should be here
 
-    uploaded = col_videos.insert_one(
+    uploaded = await col_videos.insert_one(
         {
             "user": current_user.user,
             "album": album,
@@ -116,11 +123,11 @@ async def video_get(
     current_user: User = Security(get_current_active_user, scopes=["videos.read"]),
 ):
     try:
-        video = col_videos.find_one({"_id": ObjectId(id)})
+        video = await col_videos.find_one({"_id": ObjectId(id)})
         if video is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise VideoNotFoundError(id)
+        raise VideoNotFoundError(id) from exc
 
     video_path = Path(
         f"data/users/{current_user.user}/albums/{video['album']}/{video['filename']}"
@@ -149,13 +156,13 @@ async def video_move(
     current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
 ):
     try:
-        video = col_videos.find_one({"_id": ObjectId(id)})
+        video = await col_videos.find_one({"_id": ObjectId(id)})
         if video is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise VideoNotFoundError(id)
+        raise VideoNotFoundError(id) from exc
 
-    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+    if (await col_albums.find_one({"user": current_user.user, "name": album})) is None:
         raise AlbumNameNotFoundError(album)
 
     if Path(
@@ -169,7 +176,7 @@ async def video_move(
     else:
         filename = video["filename"]
 
-    col_videos.find_one_and_update(
+    await col_videos.find_one_and_update(
         {"_id": ObjectId(id)},
         {
             "$set": {
@@ -211,13 +218,13 @@ async def video_patch(
     current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
 ):
     try:
-        video = col_videos.find_one({"_id": ObjectId(id)})
+        video = await col_videos.find_one({"_id": ObjectId(id)})
         if video is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise VideoNotFoundError(id)
+        raise VideoNotFoundError(id) from exc
 
-    col_videos.find_one_and_update(
+    await col_videos.find_one_and_update(
         {"_id": ObjectId(id)},
         {"$set": {"caption": caption, "dates.modified": datetime.now(tz=timezone.utc)}},
     )
@@ -245,13 +252,13 @@ async def video_delete(
     current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
 ):
     try:
-        video = col_videos.find_one_and_delete({"_id": ObjectId(id)})
+        video = await col_videos.find_one_and_delete({"_id": ObjectId(id)})
         if video is None:
             raise InvalidId(id)
-    except InvalidId:
+    except InvalidId as exc:
-        raise VideoNotFoundError(id)
+        raise VideoNotFoundError(id) from exc
 
-    album = col_albums.find_one({"name": video["album"]})
+    album = await col_albums.find_one({"name": video["album"]})
 
     remove(
         Path(
@@ -262,6 +269,67 @@ async def video_delete(
     return Response(status_code=HTTP_204_NO_CONTENT)
 
 
+video_random_responses = {
+    400: SearchLimitInvalidError().openapi,
+    404: AlbumNameNotFoundError("name").openapi,
+}
+
+
+@app.get(
+    "/albums/{album}/videos/random",
+    description="Get one random video, optionally by caption",
+    response_class=UJSONResponse,
+    response_model=RandomSearchResultsVideo,
+    responses=video_random_responses,
+)
+async def video_random(
+    album: str,
+    caption: Union[str, None] = None,
+    limit: int = 100,
+    current_user: User = Security(get_current_active_user, scopes=["videos.list"]),
+):
+    if (await col_albums.find_one({"user": current_user.user, "name": album})) is None:
+        raise AlbumNameNotFoundError(album)
+
+    if limit <= 0:
+        raise SearchLimitInvalidError()
+
+    output = {"results": []}
+
+    db_query = (
+        {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+        if caption is not None
+        else {
+            "user": current_user.user,
+            "album": album,
+        }
+    )
+
+    documents_count = await col_videos.count_documents(db_query)
+    skip = randint(0, documents_count - 1) if documents_count > 1 else 0
+
+    async for video in col_videos.aggregate(
+        [
+            {"$match": db_query},
+            {"$skip": skip},
+            {"$limit": limit},
+        ]
+    ):
+        output["results"].append(
+            {
+                "id": video["_id"].__str__(),
+                "filename": video["filename"],
+                "caption": video["caption"],
+            }
+        )
+
+    return UJSONResponse(output)
+
+
 video_find_responses = {
     400: SearchPageInvalidError().openapi,
     401: SearchTokenInvalidError().openapi,
@@ -287,7 +355,7 @@ async def video_find(
     current_user: User = Security(get_current_active_user, scopes=["videos.list"]),
 ):
     if token is not None:
-        found_record = col_tokens.find_one({"token": token})
+        found_record = await col_tokens.find_one({"token": token})
 
         if found_record is None:
             raise SearchTokenInvalidError()
@@ -301,7 +369,7 @@ async def video_find(
             current_user=current_user,
         )
 
-    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+    if (await col_albums.find_one({"user": current_user.user, "name": album})) is None:
         raise AlbumNameNotFoundError(album)
 
     if page <= 0 or page_size <= 0:
@@ -313,7 +381,7 @@ async def video_find(
     if q is None and caption is None:
         raise VideoSearchQueryEmptyError()
 
-    if q is None and caption is not None:
+    if q is None:
         db_query = {
             "user": current_user.user,
             "album": album,
@@ -324,30 +392,34 @@ async def video_find(
             "album": album,
             "caption": re.compile(caption),
         }
-    elif q is not None and caption is None:
+    elif caption is None:
-        db_query = list(
+        db_query = {
-            col_videos.find(
+            "user": current_user.user,
-                {"user": current_user.user, "album": album, "filename": re.compile(q)},
+            "album": album,
-                limit=page_size,
+            "filename": re.compile(q),
-                skip=skip,
+        }
-            ).sort("dates.uploaded", DESCENDING)
-        )
         db_query_count = {
             "user": current_user.user,
             "album": album,
             "caption": re.compile(q),
         }
     else:
-        db_query = list(col_videos.find({"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}, limit=page_size, skip=skip).sort("dates.uploaded", DESCENDING))  # type: ignore
+        db_query = {
-        db_query_count = {"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}  # type: ignore
+            "user": current_user.user,
+            "album": album,
+            "filename": re.compile(q),
+            "caption": re.compile(caption),
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "filename": re.compile(q),
+            "caption": re.compile(caption),
+        }
 
-    videos = list(
+    async for video in col_videos.find(db_query, limit=page_size, skip=skip).sort(
-        col_videos.find(db_query, limit=page_size, skip=skip).sort(
+        "dates.uploaded", direction=DESCENDING
-            "dates.uploaded", DESCENDING
+    ):
-        )
-    )
-
-    for video in videos:
         output["results"].append(
             {
                 "id": video["_id"].__str__(),
@@ -356,9 +428,9 @@ async def video_find(
             }
         )
 
-    if col_videos.count_documents(db_query_count) > page * page_size:
+    if (await col_videos.count_documents(db_query_count)) > page * page_size:
         token = str(token_urlsafe(32))
-        col_tokens.insert_one(
+        await col_tokens.insert_one(
             {
                 "token": token,
                 "query": q,

modules/app.py

@@ -1,14 +1,14 @@
 from fastapi import FastAPI
 from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
 
-app = FastAPI(title="END PLAY Photos", docs_url=None, redoc_url=None, version="0.4")
+app = FastAPI(title="END PLAY Photos", docs_url=None, redoc_url=None, version="0.5")
 
 
 @app.get("/docs", include_in_schema=False)
 async def custom_swagger_ui_html():
     return get_swagger_ui_html(
-        openapi_url=app.openapi_url,  # type: ignore
+        openapi_url=app.openapi_url,
-        title=app.title + " - Documentation",
+        title=f"{app.title} - Documentation",
         swagger_favicon_url="/favicon.ico",
     )
 
@@ -16,7 +16,7 @@ async def custom_swagger_ui_html():
 @app.get("/redoc", include_in_schema=False)
 async def custom_redoc_html():
     return get_redoc_html(
-        openapi_url=app.openapi_url,  # type: ignore
+        openapi_url=app.openapi_url,
-        title=app.title + " - Documentation",
+        title=f"{app.title} - Documentation",
         redoc_favicon_url="/favicon.ico",
     )

modules/database.py

@@ -1,3 +1,4 @@
+from async_pymongo import AsyncClient
 from pymongo import GEOSPHERE, MongoClient
 
 from modules.utils import configGet
@@ -17,16 +18,11 @@ else:
         db_config["host"], db_config["port"], db_config["name"]
     )
 
-db_client = MongoClient(con_string)
+db_client = AsyncClient(con_string)
+db_client_sync = MongoClient(con_string)
 
 db = db_client.get_database(name=db_config["name"])
 
-collections = db.list_collection_names()
-
-for collection in ["users", "albums", "photos", "videos", "tokens", "emails"]:
-    if not collection in collections:
-        db.create_collection(collection)
-
 col_users = db.get_collection("users")
 col_albums = db.get_collection("albums")
 col_photos = db.get_collection("photos")
@@ -34,4 +30,4 @@ col_videos = db.get_collection("videos")
 col_tokens = db.get_collection("tokens")
 col_emails = db.get_collection("emails")
 
-col_photos.create_index([("location", GEOSPHERE)])
+db_client_sync[db_config["name"]]["photos"].create_index([("location", GEOSPHERE)])

modules/exif_reader.py

@@ -1,3 +1,7 @@
+import contextlib
+from pathlib import Path
+from typing import Mapping, Union
+
 from exif import Image
 
 
@@ -12,12 +16,14 @@ def decimal_coords(coords: float, ref: str) -> float:
         * float: Decimal degrees
     """
     decimal_degrees = coords[0] + coords[1] / 60 + coords[2] / 3600
-    if ref == "S" or ref == "W":
+
+    if ref in {"S", "W"}:
         decimal_degrees = -decimal_degrees
+
     return round(decimal_degrees, 5)
 
 
-def extract_location(filepath: str) -> dict:
+def extract_location(filepath: Union[str, Path]) -> Mapping[str, float]:
     """Get location data from image
 
     ### Args:
@@ -35,11 +41,9 @@ def extract_location(filepath: str) -> dict:
     if img.has_exif is False:
         return output
 
-    try:
+    with contextlib.suppress(AttributeError):
         output["lng"] = decimal_coords(img.gps_longitude, img.gps_longitude_ref)
         output["lat"] = decimal_coords(img.gps_latitude, img.gps_latitude_ref)
         output["alt"] = img.gps_altitude
-    except AttributeError:
-        pass
 
     return output

modules/extensions_loader.py

@@ -1,6 +1,7 @@
 from importlib.util import module_from_spec, spec_from_file_location
 from os import getcwd, path, walk
 from pathlib import Path
+from typing import Union
 
 # =================================================================================
 
@@ -11,17 +12,21 @@ def get_py_files(src):
     cwd = getcwd()  # Current Working directory
     py_files = []
     for root, dirs, files in walk(src):
-        for file in files:
+        py_files.extend(
-            if file.endswith(".py"):
+            Path(f"{cwd}/{root}/{file}") for file in files if file.endswith(".py")
-                py_files.append(Path(f"{cwd}/{root}/{file}"))
+        )
     return py_files
 
 
-def dynamic_import(module_name, py_path):
+def dynamic_import(module_name: str, py_path: str):
     try:
         module_spec = spec_from_file_location(module_name, py_path)
-        module = module_from_spec(module_spec)  # type: ignore
+        if module_spec is None:
-        module_spec.loader.exec_module(module)  # type: ignore
+            raise RuntimeError(
+                f"Module spec from module name {module_name} and path {py_path} is None"
+            )
+        module = module_from_spec(module_spec)
+        module_spec.loader.exec_module(module)
         return module
     except SyntaxError:
         print(
@@ -29,12 +34,12 @@ def dynamic_import(module_name, py_path):
             flush=True,
         )
         return
-    except Exception as exp:
+    except Exception as exc:
-        print(f"Could not load extension {module_name} due to {exp}", flush=True)
+        print(f"Could not load extension {module_name} due to {exc}", flush=True)
         return
 
 
-def dynamic_import_from_src(src, star_import=False):
+def dynamic_import_from_src(src: Union[str, Path], star_import=False):
     my_py_files = get_py_files(src)
     for py_file in my_py_files:
         module_name = Path(py_file).stem

modules/hasher.py

@@ -1,3 +1,6 @@
+from pathlib import Path
+from typing import Any, List, Mapping, Union
+
 import cv2
 import numpy as np
 from numpy.typing import NDArray
@@ -6,7 +9,7 @@ from scipy import spatial
 from modules.database import col_photos
 
 
-def hash_array_to_hash_hex(hash_array):
+def hash_array_to_hash_hex(hash_array) -> str:
     # convert hash array of 0 or 1 to hash string in hex
     hash_array = np.array(hash_array, dtype=np.uint8)
     hash_str = "".join(str(i) for i in 1 * hash_array.flatten())
@@ -17,18 +20,18 @@ def hash_hex_to_hash_array(hash_hex) -> NDArray:
     # convert hash string in hex to hash values of 0 or 1
     hash_str = int(hash_hex, 16)
     array_str = bin(hash_str)[2:]
-    return np.array([i for i in array_str], dtype=np.float32)
+    return np.array(list(array_str), dtype=np.float32)
 
 
-def get_duplicates_cache(album: str) -> dict:
+async def get_duplicates_cache(album: str) -> Mapping[str, Any]:
-    output = {}
+    return {
-    for photo in col_photos.find({"album": album}):
+        photo["filename"]: [photo["_id"].__str__(), photo["hash"]]
-        output[photo["filename"]] = [photo["_id"].__str__(), photo["hash"]]
+        async for photo in col_photos.find({"album": album})
-    return output
+    }
 
 
-async def get_phash(filepath: str) -> str:
+async def get_phash(filepath: Union[str, Path]) -> str:
-    img = cv2.imread(filepath)
+    img = cv2.imread(str(filepath))
     # resize image and convert to gray scale
     img = cv2.resize(img, (64, 64))
     img = cv2.cvtColor(img, cv2.COLOR_BGR2GRAY)
@@ -49,14 +52,14 @@ async def get_phash(filepath: str) -> str:
     return hash_array_to_hash_hex(dct_block.flatten())
 
 
-async def get_duplicates(hash: str, album: str) -> list:
+async def get_duplicates(hash_string: str, album: str) -> List[Mapping[str, Any]]:
     duplicates = []
-    cache = get_duplicates_cache(album)
+    cache = await get_duplicates_cache(album)
-    for image_name in cache.keys():
+    for image_name, image_object in cache.items():
         try:
             distance = spatial.distance.hamming(
                 hash_hex_to_hash_array(cache[image_name][1]),
-                hash_hex_to_hash_array(hash),
+                hash_hex_to_hash_array(hash_string),
             )
         except ValueError:
             continue

modules/mailer.py

@@ -28,8 +28,8 @@ try:
         )
         mail_sender.ehlo()
         logger.info("Initialized SMTP connection")
-except Exception as exp:
+except Exception as exc:
-    logger.error("Could not initialize SMTP connection to: %s", exp)
+    logger.error("Could not initialize SMTP connection to: %s", exc)
     print_exc()
 
 try:
@@ -37,5 +37,5 @@ try:
         configGet("login", "mailer", "smtp"), configGet("password", "mailer", "smtp")
     )
     logger.info("Successfully initialized mailer")
-except Exception as exp:
+except Exception as exc:
-    logger.error("Could not login into provided SMTP account due to: %s", exp)
+    logger.error("Could not login into provided SMTP account due to: %s", exc)

modules/security.py

@@ -54,16 +54,20 @@ oauth2_scheme = OAuth2PasswordBearer(
 )
 
 
-def verify_password(plain_password, hashed_password):
+def verify_password(plain_password, hashed_password) -> bool:
     return pwd_context.verify(plain_password, hashed_password)
 
 
-def get_password_hash(password):
+def get_password_hash(password) -> str:
     return pwd_context.hash(password)
 
 
-def get_user(user: str):
+async def get_user(user: str) -> UserInDB:
-    found_user = col_users.find_one({"user": user})
+    found_user = await col_users.find_one({"user": user})
+
+    if found_user is None:
+        raise RuntimeError(f"User {user} does not exist")
+
     return UserInDB(
         user=found_user["user"],
         email=found_user["email"],
@@ -72,16 +76,16 @@ def get_user(user: str):
     )
 
 
-def authenticate_user(user_name: str, password: str):
+async def authenticate_user(user_name: str, password: str) -> Union[UserInDB, bool]:
-    user = get_user(user_name)
+    if user := await get_user(user_name):
-    if not user:
+        return user if verify_password(password, user.hash) else False
+    else:
         return False
-    if not verify_password(password, user.hash):
-        return False
-    return user
 
 
-def create_access_token(data: dict, expires_delta: Union[timedelta, None] = None):
+def create_access_token(
+    data: dict, expires_delta: Union[timedelta, None] = None
+) -> str:
     to_encode = data.copy()
     if expires_delta:
         expire = datetime.now(tz=timezone.utc) + expires_delta
@@ -89,14 +93,13 @@ def create_access_token(data: dict, expires_delta: Union[timedelta, None] = None
         expire = datetime.now(tz=timezone.utc) + timedelta(
             days=ACCESS_TOKEN_EXPIRE_DAYS
         )
-    to_encode.update({"exp": expire})
+    to_encode["exp"] = expire
-    encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
+    return jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
-    return encoded_jwt
 
 
 async def get_current_user(
     security_scopes: SecurityScopes, token: str = Depends(oauth2_scheme)
-):
+) -> UserInDB:
     if security_scopes.scopes:
         authenticate_value = f'Bearer scope="{security_scopes.scope_str}"'
     else:
@@ -115,12 +118,12 @@ async def get_current_user(
             raise credentials_exception
         token_scopes = payload.get("scopes", [])
         token_data = TokenData(scopes=token_scopes, user=user)
-    except (JWTError, ValidationError):
+    except (JWTError, ValidationError) as exc:
-        raise credentials_exception
+        raise credentials_exception from exc
 
-    user = get_user(user=token_data.user)
+    user_record = await get_user(user=token_data.user)
 
-    if user is None:
+    if user_record is None:
         raise credentials_exception
 
     for scope in security_scopes.scopes:
@@ -130,7 +133,7 @@ async def get_current_user(
                 detail="Not enough permissions",
                 headers={"WWW-Authenticate": authenticate_value},
             )
-    return user
+    return user_record
 
 
 async def get_current_active_user(

modules/utils.py

@@ -49,8 +49,8 @@ def jsonSave(contents: Union[list, dict], filepath: Union[str, Path]) -> None:
         with open(filepath, "w", encoding="utf8") as file:
             file.write(dumps(contents, ensure_ascii=False, indent=4))
             file.close()
-    except Exception as exp:
+    except Exception as exc:
-        logger.error("Could not save json file %s: %s\n%s", filepath, exp, format_exc())
+        logger.error("Could not save json file %s: %s\n%s", filepath, exc, format_exc())
     return
 
 

requirements.txt

@@ -1,11 +1,13 @@
-aiofiles==23.1.0
+aiofiles==23.2.1
 apscheduler~=3.10.1
 exif==1.6.0
-fastapi[all]==0.98.0
+fastapi[all]==0.103.0
-opencv-python~=4.7.0.72
+opencv-python~=4.8.0.74
 passlib~=1.7.4
-pymongo==4.4.0
+pymongo>=4.3.3
 python-jose[cryptography]~=3.3.0
 python-magic~=0.4.27
-scipy~=1.10.1
+scipy~=1.11.0
-ujson~=5.8.0
+ujson~=5.8.0
+--extra-index-url https://git.end-play.xyz/api/packages/profitroll/pypi/simple
+async_pymongo==0.1.4