Merge pull request 'Update FastAPI to 0.98.0' (#16) from dev into master

Reviewed-on: #16

.renovaterc

@@ -0,0 +1,20 @@
+{
+    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+    "extends": [
+        "config:base"
+    ],
+    "baseBranches": [
+        "dev"
+    ],
+    "packageRules": [
+        {
+            "matchUpdateTypes": [
+                "minor",
+                "patch",
+                "pin",
+                "digest"
+            ],
+            "automerge": true
+        }
+    ]
+}

README.md

@@ -0,0 +1,99 @@
+<h1 align="center">Photos API</h1>
+
+<p align="center">
+<a href="https://git.end-play.xyz/profitroll/PhotosAPILICENSE"><img alt="License: GPL" src="https://img.shields.io/badge/License-GPL-blue"></a>
+<a href="https://git.end-play.xyz/profitroll/PhotosAPI"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+</p>  
+
+Small and simple API server for saving photos and videos.
+
+## Dependencies
+
+* [Python 3.8+](https://www.python.org) (3.9+ recommended)
+* [MongoDB](https://www.mongodb.com)
+* [exiftool](https://exiftool.org)
+* [jpegoptim](https://github.com/tjko/jpegoptim)
+* [optipng](https://optipng.sourceforge.net)
+
+## Installation
+
+First you need to have a Python interpreter, MongoDB and optionally git. You can also ignore git and simply download source code, should also work fine. After that you're ready to go.  
+
+> In this README I assume that you're using default python in your
+> system and your system's PATH contains it. If your default python
+> is `python3` or for example `/home/user/.local/bin/python3.9` - use it instead.
+
+1. Install Mongo:
+
+    Please follow [official installation manual](https://www.mongodb.com/docs/manual/installation) for that.
+
+2. Download Photos API:
+
+    1. `git clone https://git.end-play.xyz/profitroll/PhotosAPI.git` (if you're using git)
+    2. `cd PhotosAPI`
+
+3. Create virtual environment [Optional yet recommended]:
+
+    1. Install virtualenv module: `pip install virtualenv`
+    2. Create venv: `python -m venv env`
+    3. Activate it using `source venv/bin/activate` on Linux, `venv\Scripts\activate.bat` in CMD or `venv\Scripts\Activate.ps1` in PowerShell.
+
+4. Install project's dependencies:  
+
+    `python -m pip install -r requirements.txt`
+
+5. Configure your API:
+
+    1. Copy file `config_example.json` to `config.json`
+    2. Open `config.json` using your favorite text editor. For example `nano config.json`
+    3. Change `"database"` keys to match your MongoDB setup
+    4. Change `"external_address"` to the ip/http address you may get in responses. By default it's `"localhost"`. This is extremely useful when running behind reverse-proxy.  
+
+    After configuring everything listed above your API will be able to boot, however further configuration can be done. You can read about it in [repository's wiki](https://git.end-play.xyz/profitroll/PhotosAPI/wiki/Configuration). There's no need to focus on that now, it makes more sense to configure it afterwards.
+
+6. Start your API:
+
+    You can run your API by the following command:  
+    `uvicorn photos_api:app --host 127.0.0.1 --port 8054`  
+
+    Learn more about available uvicorn arguments using `uvicorn --help`
+
+## Using as a service
+
+It's a good practice to use your API as a systemd service on Linux. Here's a quick overview how that can be done.  
+
+1. Create user and move your API
+
+    You don't always need to do so, but that's a cleaner way to deploy a service.  
+
+    1. Create service user `photosapi` using `sudo useradd -r -U photosapi`
+    2. Assuming you are still in directory `PhotosAPI`, use `cd ..` to go up a level and then move your API to the distinguished folder. For example, `/opt/`: `sudo mv ./PhotosAPI /opt/`
+    3. Make your user and its group own their directory using `sudo chown -R photosapi:photosapi /opt/PhotosAPI`
+
+2. Configure service
+
+    Here's an example service file for PhotosAPI that is using virtual environment:
+
+    ```systemd
+    [Unit]
+    Description=Photos API
+    After=network.target mongod.service
+    Wants=network-online.target mongod.service
+
+    [Service]
+    Restart=always
+    Type=simple
+    ExecStart=/bin/bash -c 'source venv/bin/activate && venv/bin/uvicorn photos_api:app --port 8054'
+    WorkingDirectory=/opt/PhotosAPI
+    User=photosapi
+    Group=photosapi
+
+    [Install]
+    WantedBy=multi-user.target
+    ```  
+
+    1. Create a service by pasting code above into `/etc/systemd/system/photos-api.service`
+    2. Enable your service to start on system boot using `sudo systemctl enable photos-api.service`
+    3. Start your service now using `sudo systemctl start photos-api.service`
+    4. Check if it's running using `sudo systemctl status photos-api.service`
+    5. If something goes wrong - check API's logs using `sudo journalctl -u photos-api.service`

classes/exceptions.py

@@ -0,0 +1,268 @@
+from typing import Literal
+
+from fastapi import HTTPException
+
+
+class AlbumNotFoundError(HTTPException):
+    """Raises HTTP 404 if no album with this ID found."""
+
+    def __init__(self, id: str):
+        self.id = id
+        self.openapi = {
+            "description": "Album Does Not Exist",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Could not find album with id '{id}'."}
+                }
+            },
+        }
+
+
+class AlbumNameNotFoundError(HTTPException):
+    """Raises HTTP 404 if no album with this name found."""
+
+    def __init__(self, name: str):
+        self.name = name
+        self.openapi = {
+            "description": "Album Does Not Exist",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Could not find album with name '{name}'."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=404,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(name=self.name),
+        )
+
+
+class AlbumAlreadyExistsError(HTTPException):
+    """Raises HTTP 409 if album with this name already exists."""
+
+    def __init__(self, name: str):
+        self.name = name
+        self.openapi = {
+            "description": "Album Already Exists",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Album with name '{name}' already exists."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=409,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(name=self.name),
+        )
+
+
+class AlbumIncorrectError(HTTPException):
+    """Raises HTTP 406 if album's title or name is invalid."""
+
+    def __init__(self, place: Literal["name", "title"], error: str) -> None:
+        self.place = place
+        self.error = error
+        self.openapi = {
+            "description": "Album Name/Title Invalid",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Album {place} invalid: {error}"}
+                }
+            },
+        }
+        super().__init__(
+            status_code=406,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(place=self.place, error=self.error),
+        )
+
+
+class PhotoNotFoundError(HTTPException):
+    """Raises HTTP 404 if no photo with this ID found."""
+
+    def __init__(self, id: str):
+        self.id = id
+        self.openapi = {
+            "description": "Photo Does Not Exist",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Could not find photo with id '{id}'."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=404,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(id=self.id),
+        )
+
+
+class PhotoSearchQueryEmptyError(HTTPException):
+    """Raises HTTP 422 if no photo search query provided."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Query",
+            "content": {
+                "application/json": {
+                    "example": {
+                        "detail": "You must provide query, caption or coordinates to look for photos."
+                    }
+                }
+            },
+        }
+        super().__init__(
+            status_code=422,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class VideoNotFoundError(HTTPException):
+    """Raises HTTP 404 if no video with this ID found."""
+
+    def __init__(self, id: str):
+        self.id = id
+        self.openapi = {
+            "description": "Video Does Not Exist",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Could not find video with id '{id}'."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=404,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(id=self.id),
+        )
+
+
+class VideoSearchQueryEmptyError(HTTPException):
+    """Raises HTTP 422 if no video search query provided."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Query",
+            "content": {
+                "application/json": {
+                    "example": {
+                        "detail": "You must provide query or caption to look for videos."
+                    }
+                }
+            },
+        }
+        super().__init__(
+            status_code=422,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class SearchPageInvalidError(HTTPException):
+    """Raises HTTP 400 if page or page size are not in valid range."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Page",
+            "content": {
+                "application/json": {
+                    "example": {
+                        "detail": "Parameters 'page' and 'page_size' must be greater or equal to 1."
+                    }
+                }
+            },
+        }
+        super().__init__(
+            status_code=400,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class SearchTokenInvalidError(HTTPException):
+    """Raises HTTP 401 if search token is not valid."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Token",
+            "content": {
+                "application/json": {"example": {"detail": "Invalid search token."}}
+            },
+        }
+        super().__init__(
+            status_code=401,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class UserEmailCodeInvalid(HTTPException):
+    """Raises HTTP 400 if email confirmation code is not valid."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Email Code",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Confirmation code is invalid."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=400,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class UserAlreadyExists(HTTPException):
+    """Raises HTTP 409 if user with this name already exists."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "User Already Exists",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "User with this username already exists."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=409,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class AccessTokenInvalidError(HTTPException):
+    """Raises HTTP 401 if access token is not valid."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Access Token",
+            "content": {
+                "application/json": {"example": {"detail": "Invalid access token."}}
+            },
+        }
+        super().__init__(
+            status_code=401,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class UserCredentialsInvalid(HTTPException):
+    """Raises HTTP 401 if user credentials are not valid."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Credentials",
+            "content": {
+                "application/json": {"example": {"detail": "Invalid credentials."}}
+            },
+        }
+        super().__init__(
+            status_code=401,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )

classes/models.py

@@ -1,27 +1,74 @@
-from typing import Union
+from typing import List, Union
+
 from pydantic import BaseModel
 
+
 class Photo(BaseModel):
     id: str
     album: str
     hash: str
     filename: str
 
+
+class PhotoPublic(BaseModel):
+    id: str
+    caption: str
+    filename: str
+
+
+class PhotoSearch(BaseModel):
+    id: str
+    filename: str
+    caption: Union[str, None]
+
+
 class Video(BaseModel):
     id: str
     album: str
     hash: str
     filename: str
 
+
+class VideoPublic(BaseModel):
+    id: str
+    caption: str
+    filename: str
+
+
+class VideoSearch(BaseModel):
+    id: str
+    filename: str
+    caption: Union[str, None]
+
+
 class Album(BaseModel):
     id: str
     name: str
     title: str
 
-class AlbumModified(BaseModel):
+
+class AlbumSearch(BaseModel):
+    id: str
     name: str
     title: str
 
-class SearchResults(BaseModel):
-    results: list
-    next_page: Union[str, None] = None
+
+class AlbumModified(BaseModel):
+    name: str
+    title: str
+    cover: Union[str, None]
+
+
+class SearchResultsAlbum(BaseModel):
+    results: List[Album]
+    next_page: Union[str, None]
+
+
+class SearchResultsPhoto(BaseModel):
+    results: List[PhotoSearch]
+    next_page: Union[str, None]
+
+
+class SearchResultsVideo(BaseModel):
+    results: List[VideoSearch]
+    next_page: Union[str, None]

config_example.json

@@ -7,10 +7,28 @@
         "password": null
     },
     "messages": {
-        "key_expired": "API key expired",
-        "key_invalid": "Invalid API key",
-        "key_valid": "Valid API key",
-        "bad_request": "Bad request. Read the docs at photos.end-play.xyz/docs",
-        "ip_blacklisted": "Your IP is blacklisted. Make sure you are using correct API address."
+        "email_confirmed": "Email confirmed. You can now log in."
+    },
+    "external_address": "localhost",
+    "media_token_access": false,
+    "media_token_valid_hours": 12,
+    "registration_enabled": true,
+    "registration_requires_confirmation": false,
+    "mailer": {
+        "smtp": {
+            "host": "",
+            "port": 0,
+            "sender": "",
+            "login": "",
+            "password": "",
+            "use_ssl": true,
+            "use_tls": false
+        },
+        "messages": {
+            "registration_confirmation": {
+                "subject": "Email confirmation",
+                "message": "To confirm your email please follow this link: {0}"
+            }
+        }
     }
 }

extensions/albums.py

@@ -1,151 +1,226 @@
 import re
-from os import makedirs, path, rename
+from os import makedirs, rename
+from pathlib import Path
 from shutil import rmtree
 from typing import Union
-from classes.models import Album, AlbumModified, SearchResults
-from modules.app import app
-from modules.database import col_photos, col_albums
-from modules.security import User, get_current_active_user
-from bson.objectid import ObjectId
+
 from bson.errors import InvalidId
+from bson.objectid import ObjectId
+from fastapi import Security
+from fastapi.responses import Response, UJSONResponse
+from starlette.status import HTTP_204_NO_CONTENT
 
-from fastapi import HTTPException, Security
-from fastapi.responses import UJSONResponse, Response
-from starlette.status import HTTP_204_NO_CONTENT, HTTP_404_NOT_FOUND, HTTP_406_NOT_ACCEPTABLE, HTTP_409_CONFLICT
+from classes.exceptions import (
+    AlbumAlreadyExistsError,
+    AlbumIncorrectError,
+    AlbumNotFoundError,
+)
+from classes.models import Album, AlbumModified, SearchResultsAlbum
+from modules.app import app
+from modules.database import col_albums, col_photos
+from modules.security import User, get_current_active_user
 
-@app.post("/albums", response_class=UJSONResponse, response_model=Album, description="Create album with name and title")
-async def album_create(name: str, title: str, current_user: User = Security(get_current_active_user, scopes=["albums.write"])):
+album_create_responses = {
+    406: AlbumIncorrectError("name", "error").openapi,
+    409: AlbumAlreadyExistsError("name").openapi,
+}
+
+
+@app.post(
+    "/albums",
+    description="Create album with name and title",
+    response_class=UJSONResponse,
+    response_model=Album,
+    responses=album_create_responses,
+)
+async def album_create(
+    name: str,
+    title: str,
+    current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
+):
+    if re.search(re.compile("^[a-z,0-9,_]*$"), name) is False:
+        raise AlbumIncorrectError("name", "can only contain a-z, 0-9 and _ characters.")
 
-    if re.search(re.compile('^[a-z,0-9,_]*$'), name) is False:
-        return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Album name can only contain: a-z, 0-9 and _ characters.")
-    
     if 2 > len(name) > 20:
-        return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Album name must be >2 and <20 characters.")
+        raise AlbumIncorrectError("name", "must be >2 and <20 characters.")
 
     if 2 > len(title) > 40:
-        return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Album title must be >2 and <40 characters.")
+        raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
 
-    if col_albums.find_one( {"name": name} ) is not None:
-        return HTTPException(status_code=HTTP_409_CONFLICT, detail=f"Album with name '{name}' already exists.")
+    if col_albums.find_one({"name": name}) is not None:
+        raise AlbumAlreadyExistsError(name)
 
-    makedirs(path.join("data", "users", current_user.user, "albums", name), exist_ok=True)
+    makedirs(Path(f"data/users/{current_user.user}/albums/{name}"), exist_ok=True)
 
-    uploaded = col_albums.insert_one( {"user": current_user.user, "name": name, "title": title, "cover": None} )
-
-    return UJSONResponse(
-        {
-            "id": uploaded.inserted_id.__str__(),
-            "name": name,
-            "title": title
-        }
+    uploaded = col_albums.insert_one(
+        {"user": current_user.user, "name": name, "title": title, "cover": None}
     )
 
-@app.get("/albums", response_model=SearchResults, description="Find album by name")
-async def album_find(q: str, current_user: User = Security(get_current_active_user, scopes=["albums.list"])):
+    return UJSONResponse(
+        {"id": uploaded.inserted_id.__str__(), "name": name, "title": title}
+    )
 
+
+@app.get("/albums", description="Find album by name", response_model=SearchResultsAlbum)
+async def album_find(
+    q: str,
+    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)} ))
+    albums = list(col_albums.find({"user": current_user.user, "name": re.compile(q)}))
 
     for album in albums:
-        output["results"].append( {"id": album["_id"].__str__(), "name": album["name"]} )
+        output["results"].append(
+            {
+                "id": album["_id"].__str__(),
+                "name": album["name"],
+                "title": album["title"],
+            }
+        )
 
     return UJSONResponse(output)
 
-@app.patch("/albums/{id}", response_class=UJSONResponse, response_model=AlbumModified, description="Modify album's name or title by id")
-async def album_patch(id: str, name: Union[str, None] = None, title: Union[str, None] = None, cover: Union[str, None] = None, current_user: User = Security(get_current_active_user, scopes=["albums.write"])):
 
+album_patch_responses = {
+    404: AlbumNotFoundError("id").openapi,
+    406: AlbumIncorrectError("name", "error").openapi,
+}
+
+
+@app.patch(
+    "/albums/{id}",
+    description="Modify album's name or title by id",
+    response_class=UJSONResponse,
+    response_model=AlbumModified,
+    responses=album_patch_responses,
+)
+async def album_patch(
+    id: str,
+    name: Union[str, None] = None,
+    title: Union[str, None] = None,
+    cover: Union[str, None] = None,
+    current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
+):
     try:
-        album = col_albums.find_one( {"_id": ObjectId(id)} )
+        album = col_albums.find_one({"_id": ObjectId(id)})
         if album is None:
             raise InvalidId(id)
     except InvalidId:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail="Could not find an album with such id.")
+        raise AlbumNotFoundError(id)
 
     if title is not None:
         if 2 > len(title) > 40:
-            return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Album title must be >2 and <40 characters.")
+            raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
     else:
         title = album["title"]
 
     if name is not None:
-        if re.search(re.compile('^[a-z,0-9,_]*$'), name) is False:
-            return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Album name can only contain: a-z, 0-9 and _ characters.")
+        if re.search(re.compile("^[a-z,0-9,_]*$"), name) is False:
+            raise AlbumIncorrectError(
+                "name", "can only contain a-z, 0-9 and _ characters."
+            )
         if 2 > len(name) > 20:
-            return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Album name must be >2 and <20 characters.")
+            raise AlbumIncorrectError("name", "must be >2 and <20 characters.")
         rename(
-            path.join("data", "users", current_user.user, "albums", album["name"]),
-            path.join("data", "users", current_user.user, "albums", name)
+            Path(f"data/users/{current_user.user}/albums/{album['name']}"),
+            Path(f"data/users/{current_user.user}/albums/{name}"),
+        )
+        col_photos.update_many(
+            {"user": current_user.user, "album": album["name"]},
+            {"$set": {"album": name}},
         )
-        col_photos.update_many( {"user": current_user.user, "album": album["name"]}, {"$set": {"album": name}} )
     else:
         name = album["name"]
 
     if cover is not None:
-        image = col_photos.find_one( {"_id": ObjectId(cover), "album": album["name"]} )
+        image = 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( {"_id": ObjectId(id)}, {"$set": {"name": name, "title": title, "cover": cover}} )
-
-    return UJSONResponse(
-        {
-            "name": name,
-            "title": title,
-            "cover": cover
-        }
+    col_albums.update_one(
+        {"_id": ObjectId(id)}, {"$set": {"name": name, "title": title, "cover": cover}}
     )
 
-@app.put("/albums/{id}", response_class=UJSONResponse, response_model=AlbumModified, description="Modify album's name and title by id")
-async def album_put(id: str, name: str, title: str, cover: str, current_user: User = Security(get_current_active_user, scopes=["albums.write"])):
+    return UJSONResponse({"name": name, "title": title, "cover": cover})
 
+
+album_put_responses = {
+    404: AlbumNotFoundError("id").openapi,
+    406: AlbumIncorrectError("name", "error").openapi,
+}
+
+
+@app.put(
+    "/albums/{id}",
+    description="Modify album's name and title by id",
+    response_class=UJSONResponse,
+    response_model=AlbumModified,
+    responses=album_put_responses,
+)
+async def album_put(
+    id: str,
+    name: str,
+    title: str,
+    cover: str,
+    current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
+):
     try:
-        album = col_albums.find_one( {"_id": ObjectId(id)} )
+        album = col_albums.find_one({"_id": ObjectId(id)})
         if album is None:
             raise InvalidId(id)
     except InvalidId:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail="Could not find an album with such id.")
+        raise AlbumNotFoundError(id)
 
-    if re.search(re.compile('^[a-z,0-9,_]*$'), name) is False:
-        return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Album name can only contain: a-z, 0-9 and _ characters.")
+    if re.search(re.compile("^[a-z,0-9,_]*$"), name) is False:
+        raise AlbumIncorrectError("name", "can only contain a-z, 0-9 and _ characters.")
 
     if 2 > len(name) > 20:
-        return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Album name must be >2 and <20 characters.")
+        raise AlbumIncorrectError("name", "must be >2 and <20 characters.")
 
     if 2 > len(title) > 40:
-        return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Album title must be >2 and <40 characters.")
+        raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
+
+    image = col_photos.find_one({"_id": ObjectId(cover), "album": album["name"]})
+    cover = image["_id"].__str__() if image is not None else None  # type: ignore
 
-    image = col_photos.find_one( {"_id": ObjectId(cover), "album": album["name"]} )
-    cover = image["_id"].__str__() if image is not None else None # type: ignore
-    
     rename(
-        path.join("data", "users", current_user.user, "albums", album["name"]),
-        path.join("data", "users", current_user.user, "albums", name)
+        Path(f"data/users/{current_user.user}/albums/{album['name']}"),
+        Path(f"data/users/{current_user.user}/albums/{name}"),
     )
 
-    col_photos.update_many( {"user": current_user.user, "album": album["name"]}, {"$set": {"album": name}} )
-    col_albums.update_one( {"_id": ObjectId(id)}, {"$set": {"name": name, "title": title, "cover": cover}} )
-
-    return UJSONResponse(
-        {
-            "name": name,
-            "title": title,
-            "cover": cover
-        }
+    col_photos.update_many(
+        {"user": current_user.user, "album": album["name"]}, {"$set": {"album": name}}
+    )
+    col_albums.update_one(
+        {"_id": ObjectId(id)}, {"$set": {"name": name, "title": title, "cover": cover}}
     )
 
-@app.delete("/album/{id}", response_class=UJSONResponse, description="Delete album by id")
-async def album_delete(id: str, current_user: User = Security(get_current_active_user, scopes=["albums.write"])):
+    return UJSONResponse({"name": name, "title": title, "cover": cover})
 
+
+album_delete_responses = {404: AlbumNotFoundError("id").openapi}
+
+
+@app.delete(
+    "/album/{id}",
+    description="Delete album by id",
+    status_code=HTTP_204_NO_CONTENT,
+    responses=album_delete_responses,
+)
+async def album_delete(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
+):
     try:
-        album = col_albums.find_one_and_delete( {"_id": ObjectId(id)} )
+        album = col_albums.find_one_and_delete({"_id": ObjectId(id)})
         if album is None:
             raise InvalidId(id)
     except InvalidId:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail="Could not find an album with such id.")
-    
-    col_photos.delete_many( {"album": album["name"]} )
+        raise AlbumNotFoundError(id)
 
-    rmtree(path.join("data", "users", current_user.user, "albums", album["name"]))
+    col_photos.delete_many({"album": album["name"]})
 
-    return Response(status_code=HTTP_204_NO_CONTENT)
+    rmtree(Path(f"data/users/{current_user.user}/albums/{album['name']}"))
+
+    return Response(status_code=HTTP_204_NO_CONTENT)

extensions/exceptions.py

@@ -0,0 +1,157 @@
+from fastapi import Request
+from fastapi.responses import UJSONResponse
+from starlette.status import (
+    HTTP_400_BAD_REQUEST,
+    HTTP_401_UNAUTHORIZED,
+    HTTP_404_NOT_FOUND,
+    HTTP_406_NOT_ACCEPTABLE,
+    HTTP_409_CONFLICT,
+    HTTP_422_UNPROCESSABLE_ENTITY,
+)
+
+from classes.exceptions import (
+    AlbumNotFoundError,
+    AlbumAlreadyExistsError,
+    AlbumIncorrectError,
+    PhotoNotFoundError,
+    PhotoSearchQueryEmptyError,
+    VideoNotFoundError,
+    VideoSearchQueryEmptyError,
+    SearchPageInvalidError,
+    SearchTokenInvalidError,
+    AccessTokenInvalidError,
+    UserEmailCodeInvalid,
+    UserAlreadyExists,
+    UserCredentialsInvalid,
+)
+from modules.app import app
+
+
+@app.exception_handler(AlbumNotFoundError)
+async def album_not_found_exception_handler(request: Request, exc: AlbumNotFoundError):
+    return UJSONResponse(
+        status_code=HTTP_404_NOT_FOUND,
+        content={"detail": f"Could not find album with id '{exc.id}'."},
+    )
+
+
+@app.exception_handler(AlbumAlreadyExistsError)
+async def album_already_exists_exception_handler(
+    request: Request, exc: AlbumAlreadyExistsError
+):
+    return UJSONResponse(
+        status_code=HTTP_409_CONFLICT,
+        content={"detail": f"Album with name '{exc.name}' already exists."},
+    )
+
+
+@app.exception_handler(AlbumIncorrectError)
+async def album_incorrect_exception_handler(request: Request, exc: AlbumIncorrectError):
+    return UJSONResponse(
+        status_code=HTTP_406_NOT_ACCEPTABLE,
+        content={"detail": f"Album {exc.place} invalid: {exc.error}"},
+    )
+
+
+@app.exception_handler(PhotoNotFoundError)
+async def photo_not_found_exception_handler(request: Request, exc: PhotoNotFoundError):
+    return UJSONResponse(
+        status_code=HTTP_404_NOT_FOUND,
+        content={"detail": f"Could not find photo with id '{exc.id}'."},
+    )
+
+
+@app.exception_handler(PhotoSearchQueryEmptyError)
+async def photo_search_query_empty_exception_handler(
+    request: Request, exc: PhotoSearchQueryEmptyError
+):
+    return UJSONResponse(
+        status_code=HTTP_422_UNPROCESSABLE_ENTITY,
+        content={
+            "detail": "You must provide query, caption or coordinates to look for photos."
+        },
+    )
+
+
+@app.exception_handler(VideoNotFoundError)
+async def video_not_found_exception_handler(request: Request, exc: VideoNotFoundError):
+    return UJSONResponse(
+        status_code=HTTP_404_NOT_FOUND,
+        content={"detail": f"Could not find video with id '{exc.id}'."},
+    )
+
+
+@app.exception_handler(VideoSearchQueryEmptyError)
+async def video_search_query_empty_exception_handler(
+    request: Request, exc: VideoSearchQueryEmptyError
+):
+    return UJSONResponse(
+        status_code=HTTP_422_UNPROCESSABLE_ENTITY,
+        content={
+            "detail": "You must provide query, caption or coordinates to look for photos."
+        },
+    )
+
+
+@app.exception_handler(SearchPageInvalidError)
+async def search_page_invalid_exception_handler(
+    request: Request, exc: SearchPageInvalidError
+):
+    return UJSONResponse(
+        status_code=HTTP_400_BAD_REQUEST,
+        content={
+            "detail": "Parameters 'page' and 'page_size' must be greater or equal to 1."
+        },
+    )
+
+
+@app.exception_handler(SearchTokenInvalidError)
+async def search_token_invalid_exception_handler(
+    request: Request, exc: SearchTokenInvalidError
+):
+    return UJSONResponse(
+        status_code=HTTP_401_UNAUTHORIZED,
+        content={
+            "detail": "Parameters 'page' and 'page_size' must be greater or equal to 1."
+        },
+    )
+
+
+@app.exception_handler(UserEmailCodeInvalid)
+async def user_email_code_invalid_exception_handler(
+    request: Request, exc: UserEmailCodeInvalid
+):
+    return UJSONResponse(
+        status_code=HTTP_400_BAD_REQUEST,
+        content={"detail": "Confirmation code is invalid."},
+    )
+
+
+@app.exception_handler(UserAlreadyExists)
+async def user_already_exists_exception_handler(
+    request: Request, exc: UserAlreadyExists
+):
+    return UJSONResponse(
+        status_code=HTTP_409_CONFLICT,
+        content={"detail": "User with this username already exists."},
+    )
+
+
+@app.exception_handler(AccessTokenInvalidError)
+async def access_token_invalid_exception_handler(
+    request: Request, exc: AccessTokenInvalidError
+):
+    return UJSONResponse(
+        status_code=HTTP_401_UNAUTHORIZED,
+        content={"detail": "Invalid access token."},
+    )
+
+
+@app.exception_handler(UserCredentialsInvalid)
+async def user_credentials_invalid_exception_handler(
+    request: Request, exc: UserCredentialsInvalid
+):
+    return UJSONResponse(
+        status_code=HTTP_401_UNAUTHORIZED,
+        content={"detail": "Invalid credentials."},
+    )

extensions/pages.py

@@ -1,27 +1,36 @@
-from os import path
-from modules.app import app
+from pathlib import Path
+
+import aiofiles
 from fastapi.responses import HTMLResponse, Response
 
+from modules.app import app
+
+
 @app.get("/pages/matter.css", include_in_schema=False)
 async def page_matter():
-    with open(path.join("pages", "matter.css"), "r", encoding="utf-8") as f:
-        output = f.read()
+    async with aiofiles.open(Path("pages/matter.css"), "r", encoding="utf-8") as f:
+        output = await f.read()
     return Response(content=output)
 
+
 @app.get("/pages/{page}/{file}", include_in_schema=False)
-async def page_assets(page:str, file: str):
-    with open(path.join("pages", page, file), "r", encoding="utf-8") as f:
-        output = f.read()
+async def page_assets(page: str, file: str):
+    async with aiofiles.open(Path(f"pages/{page}/{file}"), "r", encoding="utf-8") as f:
+        output = await f.read()
     return Response(content=output)
 
+
 @app.get("/", include_in_schema=False)
 async def page_home():
-    with open(path.join("pages", "home", "index.html"), "r", encoding="utf-8") as f:
-        output = f.read()
+    async with aiofiles.open(Path("pages/home/index.html"), "r", encoding="utf-8") as f:
+        output = await f.read()
     return HTMLResponse(content=output)
 
+
 @app.get("/register", include_in_schema=False)
 async def page_register():
-    with open(path.join("pages", "register", "index.html"), "r", encoding="utf-8") as f:
-        output = f.read()
-    return HTMLResponse(content=output)
+    async with aiofiles.open(
+        Path("pages/register/index.html"), "r", encoding="utf-8"
+    ) as f:
+        output = await f.read()
+    return HTMLResponse(content=output)

extensions/photos.py

@@ -1,159 +1,581 @@
+import logging
 import re
-import pickle
-from secrets import token_urlsafe
-from magic import Magic
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from os import makedirs, path, remove, system
-from classes.models import Photo, SearchResults
-from modules.hasher import get_phash, get_duplicates
-from modules.scheduler import scheduler
-from modules.security import User, get_current_active_user
-from modules.app import app
-from modules.database import col_photos, col_albums, col_tokens
-from bson.objectid import ObjectId
+from pathlib import Path
+from secrets import token_urlsafe
+from shutil import move
+from threading import Thread
+from typing import Union
+from uuid import uuid4
+
+import aiofiles
 from bson.errors import InvalidId
+from bson.objectid import ObjectId
+from fastapi import Security, UploadFile
+from fastapi.responses import Response, UJSONResponse
+from jose import JWTError, jwt
+from magic import Magic
+from plum.exceptions import UnpackError
+from pydantic import ValidationError
+from pymongo import DESCENDING
+from starlette.status import HTTP_204_NO_CONTENT, HTTP_409_CONFLICT
 
-from fastapi import HTTPException, UploadFile, Security
-from fastapi.responses import UJSONResponse, Response
-from starlette.status import HTTP_204_NO_CONTENT, HTTP_400_BAD_REQUEST, HTTP_401_UNAUTHORIZED, HTTP_404_NOT_FOUND, HTTP_409_CONFLICT
+from classes.exceptions import (
+    AccessTokenInvalidError,
+    AlbumNameNotFoundError,
+    PhotoNotFoundError,
+    PhotoSearchQueryEmptyError,
+    SearchPageInvalidError,
+    SearchTokenInvalidError,
+)
+from classes.models import Photo, PhotoPublic, SearchResultsPhoto
+from modules.app import app
+from modules.database import col_albums, col_photos, col_tokens
+from modules.exif_reader import extract_location
+from modules.hasher import get_duplicates, get_phash
+from modules.scheduler import scheduler
+from modules.security import (
+    ALGORITHM,
+    SECRET_KEY,
+    TokenData,
+    User,
+    create_access_token,
+    get_current_active_user,
+    get_user,
+)
+from modules.utils import configGet
+
+logger = logging.getLogger(__name__)
 
-from modules.utils import logWrite
 
 async def compress_image(image_path: str):
-
     image_type = Magic(mime=True).from_file(image_path)
 
     if image_type not in ["image/jpeg", "image/png"]:
-        logWrite(f"Not compressing {image_path} because its mime is '{image_type}'")
+        logger.info(
+            "Not compressing %s because its mime is '%s'", image_path, image_type
+        )
         return
 
     size_before = path.getsize(image_path) / 1024
 
-    system(f"exiftool -overwrite_original -all:all= -tagsFromFile @ -exif:Orientation {image_path}")
-
     if image_type == "image/jpeg":
-        system(f"jpegoptim {image_path} -o --max=55 -p")
+        task = Thread(
+            target=system,
+            kwargs={"command": f'jpegoptim "{image_path}" -o --max=55 -p --strip-none'},
+        )
     elif image_type == "image/png":
-        system(f"optipng -o3 {image_path}")
+        task = Thread(target=system, kwargs={"command": f'optipng -o3 "{image_path}"'})
+    else:
+        return
+
+    task.start()
+    logger.info("Compressing '%s'...", Path(image_path).name)
+    task.join()
 
     size_after = path.getsize(image_path) / 1024
-    logWrite(f"Compressed '{path.split(image_path)[-1]}' from {size_before} Kb to {size_after} Kb")
+    logger.info(
+        "Compressed '%s' from %s Kb to %s Kb",
+        Path(image_path).name,
+        size_before,
+        size_after,
+    )
 
-@app.post("/albums/{album}/photos", response_class=UJSONResponse, response_model=Photo, description="Upload a photo to album")
-async def photo_upload(file: UploadFile, album: str, ignore_duplicates: bool = False, compress: bool = True, current_user: User = Security(get_current_active_user, scopes=["photos.write"])):
 
-    if col_albums.find_one( {"user": current_user.user, "name": album} ) is None:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail=f"Provided album '{album}' does not exist.")
+photo_post_responses = {
+    404: AlbumNameNotFoundError("name").openapi,
+    409: {
+        "description": "Image Duplicates Found",
+        "content": {
+            "application/json": {
+                "example": {
+                    "detail": "Image duplicates found. Pass 'ignore_duplicates=true' to ignore.",
+                    "duplicates": ["string"],
+                    "access_token": "string",
+                }
+            }
+        },
+    },
+}
 
-    # if not file.content_type.startswith("image"):
-    #     return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Provided file is not an image, not accepting.")
 
-    makedirs(path.join("data", "users", current_user.user, "albums", album), exist_ok=True)
+@app.post(
+    "/albums/{album}/photos",
+    description="Upload a photo to album",
+    response_class=UJSONResponse,
+    response_model=Photo,
+    responses=photo_post_responses,
+)
+async def photo_upload(
+    file: UploadFile,
+    album: str,
+    ignore_duplicates: bool = False,
+    compress: bool = True,
+    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:
+        raise AlbumNameNotFoundError(album)
+
+    makedirs(Path(f"data/users/{current_user.user}/albums/{album}"), exist_ok=True)
 
     filename = file.filename
 
-    if path.exists(path.join("data", "users", current_user.user, "albums", album, file.filename)):
+    if Path(f"data/users/{current_user.user}/albums/{album}/{file.filename}").exists():
         base_name = file.filename.split(".")[:-1]
         extension = file.filename.split(".")[-1]
-        filename = ".".join(base_name)+f"_{int(datetime.now().timestamp())}."+extension
+        filename = (
+            ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
+        )
 
-    with open(path.join("data", "users", current_user.user, "albums", album, filename), "wb") as f:
-        f.write(await file.read())
+    async with aiofiles.open(
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}"), "wb"
+    ) as f:
+        await f.write(await file.read())
 
-    file_hash = await get_phash(path.join("data", "users", current_user.user, "albums", album, filename))
+    file_hash = await get_phash(
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}")
+    )
     duplicates = await get_duplicates(file_hash, album)
 
     if len(duplicates) > 0 and ignore_duplicates is False:
+        if configGet("media_token_access") is True:
+            duplicates_ids = []
+            for entry in duplicates:
+                duplicates_ids.append(entry["id"])
+            access_token = create_access_token(
+                data={
+                    "sub": current_user.user,
+                    "scopes": ["me", "photos.read"],
+                    "allowed": duplicates_ids,
+                },
+                expires_delta=timedelta(hours=configGet("media_token_valid_hours")),
+            )
+            access_token_short = uuid4().hex[:12].lower()
+            col_tokens.insert_one(
+                {
+                    "short": access_token_short,
+                    "access_token": access_token,
+                    "photos": duplicates_ids,
+                }
+            )
+        else:
+            access_token_short = None
         return UJSONResponse(
             {
                 "detail": "Image duplicates found. Pass 'ignore_duplicates=true' to ignore.",
-                "duplicates": duplicates
+                "duplicates": duplicates,
+                "access_token": access_token_short,
             },
-            status_code=HTTP_409_CONFLICT
+            status_code=HTTP_409_CONFLICT,
         )
 
-    uploaded = col_photos.insert_one( {"user": current_user.user, "album": album, "hash": file_hash, "filename": filename} )
+    try:
+        coords = extract_location(
+            Path(f"data/users/{current_user.user}/albums/{album}/{filename}")
+        )
+    except (UnpackError, ValueError):
+        coords = {"lng": 0.0, "lat": 0.0, "alt": 0.0}
+
+    uploaded = col_photos.insert_one(
+        {
+            "user": current_user.user,
+            "album": album,
+            "hash": file_hash,
+            "filename": filename,
+            "dates": {
+                "uploaded": datetime.now(tz=timezone.utc),
+                "modified": datetime.now(tz=timezone.utc),
+            },
+            "location": [coords["lng"], coords["lat"], coords["alt"]],
+            "caption": caption,
+        }
+    )
 
     if compress is True:
-        scheduler.add_job(compress_image, trigger="date", run_date=datetime.now()+timedelta(seconds=1), args=[path.join("data", "users", current_user.user, "albums", album, filename)])
+        scheduler.add_job(
+            compress_image,
+            trigger="date",
+            run_date=datetime.now() + timedelta(seconds=1),
+            args=[Path(f"data/users/{current_user.user}/albums/{album}/{filename}")],
+        )
 
     return UJSONResponse(
         {
             "id": uploaded.inserted_id.__str__(),
             "album": album,
             "hash": file_hash,
-            "filename": filename
+            "filename": filename,
         }
     )
 
-@app.get("/photos/{id}", description="Get a photo by id")
-async def photo_get(id: str, current_user: User = Security(get_current_active_user, scopes=["photos.view"])):
 
+# Access to photos y token generated for example by
+# upload method when duplicates are found. Is disabled
+# by default and should remain so if not really needed.
+if configGet("media_token_access") is True:
+    photo_get_token_responses = {
+        401: AccessTokenInvalidError().openapi,
+        404: PhotoNotFoundError("id").openapi,
+    }
+
+    @app.get(
+        "/token/photo/{token}",
+        description="Get a photo by its duplicate token",
+        responses=photo_get_token_responses,
+    )
+    async def photo_get_token(token: str, id: int):
+        db_entry = col_tokens.find_one({"short": token})
+
+        if db_entry is None:
+            raise AccessTokenInvalidError()
+
+        token = db_entry["access_token"]
+        id = db_entry["photos"][id]
+
+        try:
+            payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
+            user: str = payload.get("sub")
+            if user is None:
+                raise AccessTokenInvalidError()
+            token_scopes = payload.get("scopes", [])
+            token_data = TokenData(scopes=token_scopes, user=user)
+        except (JWTError, ValidationError) as exp:
+            print(exp, flush=True)
+            raise AccessTokenInvalidError()
+
+        user = get_user(user=token_data.user)
+
+        if id not in payload.get("allowed", []):
+            raise AccessTokenInvalidError()
+
+        try:
+            image = col_photos.find_one({"_id": ObjectId(id)})
+            if image is None:
+                raise InvalidId(id)
+        except InvalidId:
+            raise PhotoNotFoundError(id)
+
+        image_path = Path(
+            f"data/users/{user.user}/albums/{image['album']}/{image['filename']}"
+        )
+
+        mime = Magic(mime=True).from_file(image_path)
+
+        async with aiofiles.open(image_path, "rb") as f:
+            image_file = await f.read()
+
+        return Response(image_file, media_type=mime)
+
+
+photo_get_responses = {
+    200: {
+        "content": {
+            "application/octet-stream": {
+                "schema": {
+                    "type": "string",
+                    "format": "binary",
+                    "contentMediaType": "image/*",
+                }
+            }
+        }
+    },
+    404: PhotoNotFoundError("id").openapi,
+}
+
+
+@app.get(
+    "/photos/{id}",
+    description="Get a photo by id",
+    responses=photo_get_responses,
+    response_class=Response,
+)
+async def photo_get(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["photos.read"]),
+):
     try:
-        image = col_photos.find_one( {"_id": ObjectId(id)} )
+        image = col_photos.find_one({"_id": ObjectId(id)})
         if image is None:
             raise InvalidId(id)
     except InvalidId:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail="Could not find an image with such id.")
+        raise PhotoNotFoundError(id)
 
-    image_path = path.join("data", "users", current_user.user, "albums", image["album"], image["filename"])
+    image_path = Path(
+        f"data/users/{current_user.user}/albums/{image['album']}/{image['filename']}"
+    )
 
     mime = Magic(mime=True).from_file(image_path)
 
-    with open(image_path, "rb") as f: image_file = f.read() 
+    async with aiofiles.open(image_path, "rb") as f:
+        image_file = await f.read()
 
     return Response(image_file, media_type=mime)
 
-@app.delete("/photos/{id}", description="Delete a photo by id")
-async def photo_delete(id: str, current_user: User = Security(get_current_active_user, scopes=["photos.write"])):
 
+photo_move_responses = {404: PhotoNotFoundError("id").openapi}
+
+
+@app.put(
+    "/photos/{id}",
+    description="Move a photo to another album",
+    response_model=PhotoPublic,
+    responses=photo_move_responses,
+)
+async def photo_move(
+    id: str,
+    album: str,
+    current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
+):
     try:
-        image = col_photos.find_one_and_delete( {"_id": ObjectId(id)} )
+        image = col_photos.find_one({"_id": ObjectId(id)})
         if image is None:
             raise InvalidId(id)
     except InvalidId:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail="Could not find an image with such id.")
+        raise PhotoNotFoundError(id)
 
-    album = col_albums.find_one( {"name": image["album"]} )
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
+
+    if Path(
+        f"data/users/{current_user.user}/albums/{album}/{image['filename']}"
+    ).exists():
+        base_name = image["filename"].split(".")[:-1]
+        extension = image["filename"].split(".")[-1]
+        filename = (
+            ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
+        )
+    else:
+        filename = image["filename"]
+
+    col_photos.find_one_and_update(
+        {"_id": ObjectId(id)},
+        {
+            "$set": {
+                "album": album,
+                "filename": filename,
+                "dates.modified": datetime.now(tz=timezone.utc),
+            }
+        },
+    )
+
+    move(
+        Path(
+            f"data/users/{current_user.user}/albums/{image['album']}/{image['filename']}"
+        ),
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}"),
+    )
+
+    return UJSONResponse(
+        {
+            "id": image["_id"].__str__(),
+            "caption": image["caption"],
+            "filename": filename,
+        }
+    )
+
+
+photo_patch_responses = {404: PhotoNotFoundError("id").openapi}
+
+
+@app.patch(
+    "/photos/{id}",
+    description="Change properties of a photo",
+    response_model=PhotoPublic,
+    responses=photo_patch_responses,
+)
+async def photo_patch(
+    id: str,
+    caption: str,
+    current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
+):
+    try:
+        image = col_photos.find_one({"_id": ObjectId(id)})
+        if image is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise PhotoNotFoundError(id)
+
+    col_photos.find_one_and_update(
+        {"_id": ObjectId(id)},
+        {"$set": {"caption": caption, "dates.modified": datetime.now(tz=timezone.utc)}},
+    )
+
+    return UJSONResponse(
+        {
+            "id": image["_id"].__str__(),
+            "caption": caption,
+            "filename": image["filename"],
+        }
+    )
+
+
+photo_delete_responses = {404: PhotoNotFoundError("id").openapi}
+
+
+@app.delete(
+    "/photos/{id}",
+    description="Delete a photo by id",
+    status_code=HTTP_204_NO_CONTENT,
+    responses=photo_delete_responses,
+)
+async def photo_delete(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
+):
+    try:
+        image = col_photos.find_one_and_delete({"_id": ObjectId(id)})
+        if image is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise PhotoNotFoundError(id)
+
+    album = 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}} )
+        col_albums.update_one({"name": image["album"]}, {"$set": {"cover": None}})
 
-    remove(path.join("data", "users", current_user.user, "albums", image["album"], image["filename"]))
+    remove(
+        Path(
+            f"data/users/{current_user.user}/albums/{image['album']}/{image['filename']}"
+        )
+    )
 
     return Response(status_code=HTTP_204_NO_CONTENT)
 
-@app.get("/albums/{album}/photos", response_class=UJSONResponse, response_model=SearchResults, description="Find a photo by filename")
-async def photo_find(q: str, album: str, page: int = 1, page_size: int = 100, current_user: User = Security(get_current_active_user, scopes=["photos.list"])):
 
-    if col_albums.find_one( {"user": current_user.user, "name": album} ) is None:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail=f"Provided album '{album}' does not exist.")
+photo_find_responses = {
+    400: SearchPageInvalidError().openapi,
+    401: SearchTokenInvalidError().openapi,
+    404: AlbumNameNotFoundError("name").openapi,
+    422: PhotoSearchQueryEmptyError().openapi,
+}
+
+
+@app.get(
+    "/albums/{album}/photos",
+    description="Find a photo by filename, caption, location or token",
+    response_class=UJSONResponse,
+    response_model=SearchResultsPhoto,
+    responses=photo_find_responses,
+)
+async def photo_find(
+    album: str,
+    q: Union[str, None] = None,
+    caption: Union[str, None] = None,
+    token: Union[str, None] = None,
+    page: int = 1,
+    page_size: int = 100,
+    lat: Union[float, None] = None,
+    lng: Union[float, None] = None,
+    radius: Union[int, None] = None,
+    current_user: User = Security(get_current_active_user, scopes=["photos.list"]),
+):
+    if token is not None:
+        found_record = col_tokens.find_one({"token": token})
+
+        if found_record is None:
+            raise SearchTokenInvalidError()
+
+        return await photo_find(
+            album=album,
+            q=found_record["query"],
+            caption=found_record["caption"],
+            lat=found_record["lat"],
+            lng=found_record["lng"],
+            radius=found_record["radius"],
+            page=found_record["page"],
+            page_size=found_record["page_size"],
+            current_user=current_user,
+        )
+
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
 
     if page <= 0 or page_size <= 0:
-        return HTTPException(status_code=HTTP_400_BAD_REQUEST, detail="Parameters 'page' and 'page_size' must be greater or equal to 1.")
+        raise SearchPageInvalidError()
 
     output = {"results": []}
-    skip = (page-1)*page_size
-    images = list(col_photos.find({"user": current_user.user, "album": album, "filename": re.compile(q)}, limit=page_size, skip=skip))
+    skip = (page - 1) * page_size
+
+    radius = 5000 if radius is None else radius
+
+    if (lat is not None) and (lng is not None):
+        db_query = {
+            "user": current_user.user,
+            "album": album,
+            "location": {
+                "$nearSphere": {
+                    "$geometry": {"type": "Point", "coordinates": [lng, lat]},
+                    "$maxDistance": radius,
+                }
+            },
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "location": {"$geoWithin": {"$centerSphere": [[lng, lat], radius]}},
+        }
+    elif q is None and caption is None:
+        raise PhotoSearchQueryEmptyError()
+    elif q is None and caption is not None:
+        db_query = {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+    elif q is not None and caption is None:
+        db_query = {
+            "user": current_user.user,
+            "album": album,
+            "filename": re.compile(q),
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "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_count = {"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}  # type: ignore
+
+    images = list(
+        col_photos.find(db_query, limit=page_size, skip=skip).sort(
+            "dates.uploaded", DESCENDING
+        )
+    )
 
     for image in images:
-        output["results"].append({"id": image["_id"].__str__(), "filename": image["filename"]})
+        output["results"].append(
+            {
+                "id": image["_id"].__str__(),
+                "filename": image["filename"],
+                "caption": image["caption"],
+            }
+        )
 
-    if col_photos.count_documents( {"user": current_user.user, "album": album, "filename": re.compile(q)} ) > page*page_size:
+    if col_photos.count_documents(db_query_count) > page * page_size:
         token = str(token_urlsafe(32))
-        col_tokens.insert_one( {"token": token, "query": q, "album": album, "page": page+1, "page_size": page_size, "user": pickle.dumps(current_user)} )
-        output["next_page"] = f"/albums/{album}/photos/token?token={token}" # type: ignore
+        col_tokens.insert_one(
+            {
+                "token": token,
+                "query": q,
+                "caption": caption,
+                "lat": lat,
+                "lng": lng,
+                "radius": radius,
+                "page": page + 1,
+                "page_size": page_size,
+            }
+        )
+        output["next_page"] = f"/albums/{album}/photos/?token={token}"  # type: ignore
     else:
-        output["next_page"] = None # type: ignore
+        output["next_page"] = None  # type: ignore
 
     return UJSONResponse(output)
-
-@app.get("/albums/{album}/photos/token", response_class=UJSONResponse, response_model=SearchResults, description="Find a photo by token")
-async def photo_find_token(token: str):
-
-    found_record = col_tokens.find_one( {"token": token} )
-
-    if found_record is None:
-        return HTTPException(status_code=HTTP_401_UNAUTHORIZED, detail="Invalid search token.")
-
-    return await photo_find(q=found_record["query"], album=found_record["album"], page=found_record["page"], page_size=found_record["page_size"], current_user=pickle.loads(found_record["user"]))

extensions/security.py

@@ -1,55 +1,28 @@
 from datetime import timedelta
-from modules.database import col_users
+
+from fastapi import Depends
+from fastapi.security import OAuth2PasswordRequestForm
+
+from classes.exceptions import UserCredentialsInvalid
 from modules.app import app
-
-from fastapi import Depends, HTTPException, Response
-from starlette.status import HTTP_204_NO_CONTENT
-from fastapi.security import (
-    OAuth2PasswordRequestForm,
-)
-
 from modules.security import (
     ACCESS_TOKEN_EXPIRE_DAYS,
     Token,
-    User,
     authenticate_user,
     create_access_token,
-    get_current_active_user,
-    get_password_hash
 )
 
+token_post_responses = {401: UserCredentialsInvalid().openapi}
 
-@app.post("/token", response_model=Token)
+
+@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)
     if not user:
-        raise HTTPException(status_code=400, detail="Incorrect user or password")
+        raise UserCredentialsInvalid()
     access_token_expires = timedelta(days=ACCESS_TOKEN_EXPIRE_DAYS)
     access_token = create_access_token(
         data={"sub": user.user, "scopes": form_data.scopes},
         expires_delta=access_token_expires,
     )
     return {"access_token": access_token, "token_type": "bearer"}
-
-
-@app.get("/users/me/", response_model=User)
-async def read_users_me(current_user: User = Depends(get_current_active_user)):
-    return current_user
-
-
-@app.post("/users", response_class=Response)
-async def create_users(user: str, email: str, password: str):
-    col_users.insert_one( {"user": user, "email": email, "hash": get_password_hash(password), "disabled": True} )
-    return Response(status_code=HTTP_204_NO_CONTENT)
-
-
-# @app.get("/users/me/items/")
-# async def read_own_items(
-#     current_user: User = Security(get_current_active_user, scopes=["items"])
-# ):
-#     return [{"item_id": "Foo", "owner": current_user.user}]
-
-
-# @app.get("/status/")
-# async def read_system_status(current_user: User = Depends(get_current_user)):
-#     return {"status": "ok"}

extensions/users.py

@@ -0,0 +1,145 @@
+import logging
+from datetime import datetime, timedelta
+from uuid import uuid1
+
+from fastapi import Depends, Form
+from fastapi.responses import Response, UJSONResponse
+from starlette.status import HTTP_204_NO_CONTENT
+
+from classes.exceptions import (
+    UserAlreadyExists,
+    UserCredentialsInvalid,
+    UserEmailCodeInvalid,
+)
+from modules.app import app
+from modules.database import col_albums, col_emails, col_photos, col_users, col_videos
+from modules.mailer import mail_sender
+from modules.scheduler import scheduler
+from modules.security import (
+    User,
+    get_current_active_user,
+    get_password_hash,
+    get_user,
+    verify_password,
+)
+from modules.utils import configGet
+
+logger = logging.getLogger(__name__)
+
+
+async def send_confirmation(user: str, email: str):
+    confirmation_code = str(uuid1())
+    try:
+        mail_sender.sendmail(
+            from_addr=configGet("sender", "mailer", "smtp"),
+            to_addrs=email,
+            msg=f'From: {configGet("sender", "mailer", "smtp")}\nSubject: Email confirmation\n\n'
+            + configGet(
+                "message", "mailer", "messages", "registration_confirmation"
+            ).format(
+                configGet("external_address")
+                + f"/users/{user}/confirm?code={confirmation_code}"
+            ),
+        )
+        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:
+        logger.error("Could not send confirmation email to '%s' due to: %s", email, exp)
+
+
+@app.get("/users/me/", response_model=User)
+async def user_me(current_user: User = Depends(get_current_active_user)):
+    return current_user
+
+
+user_confirm_responses = {
+    200: {
+        "description": "Successful Response",
+        "content": {
+            "application/json": {
+                "example": {"detail": configGet("email_confirmed", "messages")}
+            }
+        },
+    },
+    400: UserEmailCodeInvalid().openapi,
+}
+if configGet("registration_requires_confirmation") is True:
+
+    @app.get(
+        "/users/{user}/confirm",
+        response_class=UJSONResponse,
+        responses=user_confirm_responses,
+    )
+    @app.patch(
+        "/users/{user}/confirm",
+        response_class=UJSONResponse,
+        responses=user_confirm_responses,
+    )
+    async def user_confirm(user: str, code: str):
+        confirm_record = col_emails.find_one(
+            {"user": user, "code": code, "used": False}
+        )
+        if confirm_record is None:
+            raise UserEmailCodeInvalid()
+        col_emails.find_one_and_update(
+            {"_id": confirm_record["_id"]}, {"$set": {"used": True}}
+        )
+        col_users.find_one_and_update(
+            {"user": confirm_record["user"]}, {"$set": {"disabled": False}}
+        )
+        return UJSONResponse({"detail": configGet("email_confirmed", "messages")})
+
+
+user_create_responses = {409: UserAlreadyExists().openapi}
+if configGet("registration_enabled") is True:
+
+    @app.post(
+        "/users", status_code=HTTP_204_NO_CONTENT, responses=user_create_responses
+    )
+    async def user_create(
+        user: str = Form(), email: str = Form(), password: str = Form()
+    ):
+        if col_users.find_one({"user": user}) is not None:
+            raise UserAlreadyExists()
+        col_users.insert_one(
+            {
+                "user": user,
+                "email": email,
+                "hash": get_password_hash(password),
+                "disabled": configGet("registration_requires_confirmation"),
+            }
+        )
+        if configGet("registration_requires_confirmation") is True:
+            scheduler.add_job(
+                send_confirmation,
+                trigger="date",
+                run_date=datetime.now() + timedelta(seconds=1),
+                kwargs={"user": user, "email": email},
+            )
+        return Response(status_code=HTTP_204_NO_CONTENT)
+
+
+user_delete_responses = {401: UserCredentialsInvalid().openapi}
+
+
+@app.delete(
+    "/users/me/", status_code=HTTP_204_NO_CONTENT, responses=user_delete_responses
+)
+async def user_delete(
+    password: str = Form(), current_user: User = Depends(get_current_active_user)
+):
+    user = 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})
+    col_emails.delete_many({"user": current_user.user})
+    col_photos.delete_many({"user": current_user.user})
+    col_videos.delete_many({"user": current_user.user})
+    col_albums.delete_many({"user": current_user.user})
+    return Response(status_code=HTTP_204_NO_CONTENT)

extensions/videos.py

@@ -1,129 +1,374 @@
 import re
-import pickle
+from datetime import datetime, timezone
+from os import makedirs, remove
+from pathlib import Path
 from secrets import token_urlsafe
-from magic import Magic
-from datetime import datetime
-from os import makedirs, path, remove
-from classes.models import Video, SearchResults
-from modules.security import User, get_current_active_user
-from modules.app import app
-from modules.database import col_videos, col_albums, col_tokens
-from bson.objectid import ObjectId
+from shutil import move
+from typing import Union
+
+import aiofiles
 from bson.errors import InvalidId
+from bson.objectid import ObjectId
+from fastapi import Security, UploadFile
+from fastapi.responses import Response, UJSONResponse
+from magic import Magic
+from pymongo import DESCENDING
+from starlette.status import HTTP_204_NO_CONTENT
 
-from fastapi import HTTPException, UploadFile, Security
-from fastapi.responses import UJSONResponse, Response
-from starlette.status import HTTP_204_NO_CONTENT, HTTP_400_BAD_REQUEST, HTTP_401_UNAUTHORIZED, HTTP_404_NOT_FOUND
+from classes.exceptions import (
+    AlbumNameNotFoundError,
+    SearchPageInvalidError,
+    SearchTokenInvalidError,
+    VideoNotFoundError,
+    VideoSearchQueryEmptyError,
+)
+from classes.models import 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
+
+video_post_responses = {404: AlbumNameNotFoundError("name").openapi}
 
 
-@app.post("/albums/{album}/videos", response_class=UJSONResponse, response_model=Video, description="Upload a video to album")
-async def video_upload(file: UploadFile, album: str, current_user: User = Security(get_current_active_user, scopes=["videos.write"])):
+@app.post(
+    "/albums/{album}/videos",
+    description="Upload a video to album",
+    response_class=UJSONResponse,
+    response_model=Video,
+    responses=video_post_responses,
+)
+async def video_upload(
+    file: UploadFile,
+    album: str,
+    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:
+        raise AlbumNameNotFoundError(album)
 
-    if col_albums.find_one( {"user": current_user.user, "name": album} ) is None:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail=f"Provided album '{album}' does not exist.")
-
-    # if not file.content_type.startswith("video"):
-    #     return HTTPException(status_code=HTTP_406_NOT_ACCEPTABLE, detail="Provided file is not a video, not accepting.")
-
-    makedirs(path.join("data", "users", current_user.user, "albums", album), exist_ok=True)
+    makedirs(Path(f"data/users/{current_user.user}/albums/{album}"), exist_ok=True)
 
     filename = file.filename
 
-    if path.exists(path.join("data", "users", current_user.user, "albums", album, file.filename)):
+    if Path(f"data/users/{current_user.user}/albums/{album}/{file.filename}").exists():
         base_name = file.filename.split(".")[:-1]
         extension = file.filename.split(".")[-1]
-        filename = ".".join(base_name)+f"_{int(datetime.now().timestamp())}."+extension
+        filename = (
+            ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
+        )
 
-    with open(path.join("data", "users", current_user.user, "albums", album, filename), "wb") as f:
-        f.write(await file.read())
+    async with aiofiles.open(
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}"), "wb"
+    ) as f:
+        await f.write(await file.read())
 
-    # file_hash = await get_phash(path.join("data", "users", current_user.user, "albums", album, filename))
-    # duplicates = await get_duplicates(file_hash, album)
+    # Hashing and duplicates check should be here
 
-    # if len(duplicates) > 0 and ignore_duplicates is False:
-    #     return UJSONResponse(
-    #         {
-    #             "detail": "video duplicates found. Pass 'ignore_duplicates=true' to ignore.",
-    #             "duplicates": duplicates
-    #         },
-    #         status_code=HTTP_409_CONFLICT
-    #     )
+    # Coords extraction should be here
 
-    uploaded = col_videos.insert_one( {"user": current_user.user, "album": album, "filename": filename} )
+    uploaded = col_videos.insert_one(
+        {
+            "user": current_user.user,
+            "album": album,
+            "filename": filename,
+            "dates": {
+                "uploaded": datetime.now(tz=timezone.utc),
+                "modified": datetime.now(tz=timezone.utc),
+            },
+            "caption": caption,
+        }
+    )
 
     return UJSONResponse(
         {
             "id": uploaded.inserted_id.__str__(),
             "album": album,
-            "filename": filename
+            "hash": "",  # SHOULD BE DONE
+            "filename": filename,
         }
     )
 
-@app.get("/videos/{id}", description="Get a video by id")
-async def video_get(id: str, current_user: User = Security(get_current_active_user, scopes=["videos.view"])):
 
+video_get_responses = {
+    200: {
+        "content": {
+            "application/octet-stream": {
+                "schema": {
+                    "type": "string",
+                    "format": "binary",
+                    "contentMediaType": "video/*",
+                }
+            }
+        }
+    },
+    404: VideoNotFoundError("id").openapi,
+}
+
+
+@app.get(
+    "/videos/{id}",
+    description="Get a video by id",
+    responses=video_get_responses,
+    response_class=Response,
+)
+async def video_get(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["videos.read"]),
+):
     try:
-        video = col_videos.find_one( {"_id": ObjectId(id)} )
+        video = col_videos.find_one({"_id": ObjectId(id)})
         if video is None:
             raise InvalidId(id)
     except InvalidId:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail="Could not find a video with such id.")
+        raise VideoNotFoundError(id)
 
-    video_path = path.join("data", "users", current_user.user, "albums", video["album"], video["filename"])
+    video_path = Path(
+        f"data/users/{current_user.user}/albums/{video['album']}/{video['filename']}"
+    )
 
     mime = Magic(mime=True).from_file(video_path)
 
-    with open(video_path, "rb") as f: video_file = f.read() 
+    async with aiofiles.open(video_path, "rb") as f:
+        video_file = await f.read()
 
-    return Response(video_file, media_type=mime)
+    return Response(content=video_file, media_type=mime)
 
-@app.delete("/videos/{id}", description="Delete a video by id")
-async def video_delete(id: str, current_user: User = Security(get_current_active_user, scopes=["videos.write"])):
 
+video_move_responses = {404: VideoNotFoundError("id").openapi}
+
+
+@app.put(
+    "/videos/{id}",
+    description="Move a video into another album",
+    response_model=VideoPublic,
+    responses=video_move_responses,
+)
+async def video_move(
+    id: str,
+    album: str,
+    current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
+):
     try:
-        video = col_videos.find_one_and_delete( {"_id": ObjectId(id)} )
+        video = col_videos.find_one({"_id": ObjectId(id)})
         if video is None:
             raise InvalidId(id)
     except InvalidId:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail="Could not find a video with such id.")
+        raise VideoNotFoundError(id)
 
-    album = col_albums.find_one( {"name": video["album"]} )
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
 
-    remove(path.join("data", "users", current_user.user, "albums", video["album"], video["filename"]))
+    if Path(
+        f"data/users/{current_user.user}/albums/{album}/{video['filename']}"
+    ).exists():
+        base_name = video["filename"].split(".")[:-1]
+        extension = video["filename"].split(".")[-1]
+        filename = (
+            ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
+        )
+    else:
+        filename = video["filename"]
+
+    col_videos.find_one_and_update(
+        {"_id": ObjectId(id)},
+        {
+            "$set": {
+                "album": album,
+                "filename": filename,
+                "dates.modified": datetime.now(tz=timezone.utc),
+            }
+        },
+    )
+
+    move(
+        Path(
+            f"data/users/{current_user.user}/albums/{video['album']}/{video['filename']}"
+        ),
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}"),
+    )
+
+    return UJSONResponse(
+        {
+            "id": video["_id"].__str__(),
+            "caption": video["caption"],
+            "filename": filename,
+        }
+    )
+
+
+video_patch_responses = {404: VideoNotFoundError("id").openapi}
+
+
+@app.patch(
+    "/videos/{id}",
+    description="Change properties of a video",
+    response_model=VideoPublic,
+    responses=video_patch_responses,
+)
+async def video_patch(
+    id: str,
+    caption: str,
+    current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
+):
+    try:
+        video = col_videos.find_one({"_id": ObjectId(id)})
+        if video is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise VideoNotFoundError(id)
+
+    col_videos.find_one_and_update(
+        {"_id": ObjectId(id)},
+        {"$set": {"caption": caption, "dates.modified": datetime.now(tz=timezone.utc)}},
+    )
+
+    return UJSONResponse(
+        {
+            "id": video["_id"].__str__(),
+            "caption": video["caption"],
+            "filename": video["filename"],
+        }
+    )
+
+
+video_delete_responses = {404: VideoNotFoundError("id").openapi}
+
+
+@app.delete(
+    "/videos/{id}",
+    description="Delete a video by id",
+    status_code=HTTP_204_NO_CONTENT,
+    responses=video_delete_responses,
+)
+async def video_delete(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
+):
+    try:
+        video = col_videos.find_one_and_delete({"_id": ObjectId(id)})
+        if video is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise VideoNotFoundError(id)
+
+    album = col_albums.find_one({"name": video["album"]})
+
+    remove(
+        Path(
+            f"data/users/{current_user.user}/albums/{video['album']}/{video['filename']}"
+        )
+    )
 
     return Response(status_code=HTTP_204_NO_CONTENT)
 
-@app.get("/albums/{album}/videos", response_class=UJSONResponse, response_model=SearchResults, description="Find a video by filename")
-async def video_find(q: str, album: str, page: int = 1, page_size: int = 100, current_user: User = Security(get_current_active_user, scopes=["videos.list"])):
 
-    if col_albums.find_one( {"user": current_user.user, "name": album} ) is None:
-        return HTTPException(status_code=HTTP_404_NOT_FOUND, detail=f"Provided album '{album}' does not exist.")
+video_find_responses = {
+    400: SearchPageInvalidError().openapi,
+    401: SearchTokenInvalidError().openapi,
+    404: AlbumNameNotFoundError("name").openapi,
+    422: VideoSearchQueryEmptyError().openapi,
+}
+
+
+@app.get(
+    "/albums/{album}/videos",
+    description="Find a video by filename, caption or token",
+    response_class=UJSONResponse,
+    response_model=SearchResultsVideo,
+    responses=video_find_responses,
+)
+async def video_find(
+    album: str,
+    q: Union[str, None] = None,
+    caption: Union[str, None] = None,
+    token: Union[str, None] = None,
+    page: int = 1,
+    page_size: int = 100,
+    current_user: User = Security(get_current_active_user, scopes=["videos.list"]),
+):
+    if token is not None:
+        found_record = col_tokens.find_one({"token": token})
+
+        if found_record is None:
+            raise SearchTokenInvalidError()
+
+        return await video_find(
+            album=album,
+            q=found_record["query"],
+            caption=found_record["caption"],
+            page=found_record["page"],
+            page_size=found_record["page_size"],
+            current_user=current_user,
+        )
+
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
 
     if page <= 0 or page_size <= 0:
-        return HTTPException(status_code=HTTP_400_BAD_REQUEST, detail="Parameters 'page' and 'page_size' must be greater or equal to 1.")
+        raise SearchPageInvalidError()
 
     output = {"results": []}
-    skip = (page-1)*page_size
-    videos = list(col_videos.find({"user": current_user.user, "album": album, "filename": re.compile(q)}, limit=page_size, skip=skip))
+    skip = (page - 1) * page_size
+
+    if q is None and caption is None:
+        raise VideoSearchQueryEmptyError()
+
+    if q is None and caption is not None:
+        db_query = {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+    elif q is not None and caption is None:
+        db_query = list(
+            col_videos.find(
+                {"user": current_user.user, "album": album, "filename": re.compile(q)},
+                limit=page_size,
+                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_count = {"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}  # type: ignore
+
+    videos = list(
+        col_videos.find(db_query, limit=page_size, skip=skip).sort(
+            "dates.uploaded", DESCENDING
+        )
+    )
 
     for video in videos:
-        output["results"].append({"id": video["_id"].__str__(), "filename": video["filename"]})
+        output["results"].append(
+            {
+                "id": video["_id"].__str__(),
+                "filename": video["filename"],
+                "caption": video["caption"],
+            }
+        )
 
-    if col_videos.count_documents( {"user": current_user.user, "album": album, "filename": re.compile(q)} ) > page*page_size:
+    if col_videos.count_documents(db_query_count) > page * page_size:
         token = str(token_urlsafe(32))
-        col_tokens.insert_one( {"token": token, "query": q, "album": album, "page": page+1, "page_size": page_size, "user": pickle.dumps(current_user)} )
-        output["next_page"] = f"/albums/{album}/videos/token?token={token}" # type: ignore
+        col_tokens.insert_one(
+            {
+                "token": token,
+                "query": q,
+                "caption": caption,
+                "page": page + 1,
+                "page_size": page_size,
+            }
+        )
+        output["next_page"] = f"/albums/{album}/videos/?token={token}"  # type: ignore
     else:
-        output["next_page"] = None # type: ignore
+        output["next_page"] = None  # type: ignore
 
     return UJSONResponse(output)
-
-@app.get("/albums/{album}/videos/token", response_class=UJSONResponse, response_model=SearchResults, description="Find a video by token")
-async def video_find_token(token: str):
-
-    found_record = col_tokens.find_one( {"token": token} )
-
-    if found_record is None:
-        return HTTPException(status_code=HTTP_401_UNAUTHORIZED, detail="Invalid search token.")
-
-    return await video_find(q=found_record["query"], album=found_record["album"], page=found_record["page"], page_size=found_record["page_size"], current_user=pickle.loads(found_record["user"]))

modules/app.py

@@ -1,79 +1,22 @@
-from os import sep
-from fastapi import FastAPI, Security, HTTPException
-from starlette.status import HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN
-from fastapi.security import APIKeyQuery, APIKeyHeader, APIKeyCookie
-from fastapi.openapi.docs import get_swagger_ui_html, get_redoc_html
-from starlette.status import HTTP_401_UNAUTHORIZED
-from fastapi.openapi.models import APIKey
+from fastapi import FastAPI
+from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
 
-from modules.utils import configGet, jsonLoad
+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.1")
-
-api_key_query = APIKeyQuery(name="apikey", auto_error=False)
-api_key_header = APIKeyHeader(name="apikey", auto_error=False)
-api_key_cookie = APIKeyCookie(name="apikey", auto_error=False)
-
-
-def get_all_api_keys():
-    return jsonLoad(f'{configGet("data_location")}{sep}api_keys.json')
-
-def get_all_expired_keys():
-    return jsonLoad(f'{configGet("data_location")}{sep}expired_keys.json')
-    
-def check_project_key(project: str, apikey: APIKey) -> bool:
-    keys = jsonLoad(f'{configGet("data_location")}{sep}api_keys.json')
-    if apikey in keys:
-        if keys[apikey] != []:
-            if project in keys[apikey]:
-                return True
-            else:
-                return False
-        else:
-            return False
-    else:
-        return False
-
-
-async def get_api_key(
-    api_key_query: str = Security(api_key_query),
-    api_key_header: str = Security(api_key_header),
-    api_key_cookie: str = Security(api_key_cookie),
-):
-
-    keys = get_all_api_keys()
-    expired = get_all_expired_keys()
-
-    def is_valid(key):
-        if (key in keys) or (key == "publickey"):
-            return True
-        else:
-            return False
-
-    if is_valid(api_key_query):
-        return api_key_query
-    elif is_valid(api_key_header):
-        return api_key_header
-    elif is_valid(api_key_cookie):
-        return api_key_cookie
-    else:
-        if (api_key_query in expired) or (api_key_header in expired) or (api_key_cookie in expired):
-            raise HTTPException(status_code=HTTP_403_FORBIDDEN, detail=configGet("key_expired", "messages"))
-        else:
-            raise HTTPException(status_code=HTTP_401_UNAUTHORIZED, detail=configGet("key_invalid", "messages"))
 
 @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,  # type: ignore
         title=app.title + " - Documentation",
-        swagger_favicon_url="/favicon.ico"
+        swagger_favicon_url="/favicon.ico",
     )
 
+
 @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,  # type: ignore
         title=app.title + " - Documentation",
-        redoc_favicon_url="/favicon.ico"
-    )
+        redoc_favicon_url="/favicon.ico",
+    )

modules/database.py

@@ -1,21 +1,20 @@
+from pymongo import GEOSPHERE, MongoClient
+
 from modules.utils import configGet
-from pymongo import MongoClient
 
 db_config = configGet("database")
 
 if db_config["user"] is not None and db_config["password"] is not None:
-    con_string = 'mongodb://{0}:{1}@{2}:{3}/{4}'.format(
+    con_string = "mongodb://{0}:{1}@{2}:{3}/{4}".format(
         db_config["user"],
         db_config["password"],
         db_config["host"],
         db_config["port"],
-        db_config["name"]
+        db_config["name"],
     )
 else:
-    con_string = 'mongodb://{0}:{1}/{2}'.format(
-        db_config["host"],
-        db_config["port"],
-        db_config["name"]
+    con_string = "mongodb://{0}:{1}/{2}".format(
+        db_config["host"], db_config["port"], db_config["name"]
     )
 
 db_client = MongoClient(con_string)
@@ -24,7 +23,7 @@ db = db_client.get_database(name=db_config["name"])
 
 collections = db.list_collection_names()
 
-for collection in ["users", "albums", "photos", "videos", "tokens"]:
+for collection in ["users", "albums", "photos", "videos", "tokens", "emails"]:
     if not collection in collections:
         db.create_collection(collection)
 
@@ -32,4 +31,7 @@ col_users = db.get_collection("users")
 col_albums = db.get_collection("albums")
 col_photos = db.get_collection("photos")
 col_videos = db.get_collection("videos")
-col_tokens = db.get_collection("tokens")
+col_tokens = db.get_collection("tokens")
+col_emails = db.get_collection("emails")
+
+col_photos.create_index([("location", GEOSPHERE)])

modules/exif_reader.py

@@ -0,0 +1,45 @@
+from exif import Image
+
+
+def decimal_coords(coords: float, ref: str) -> float:
+    """Get latitude/longitude from coord and direction reference
+
+    ### Args:
+        * coords (`float`): _description_
+        * ref (`str`): _description_
+
+    ### Returns:
+        * float: Decimal degrees
+    """
+    decimal_degrees = coords[0] + coords[1] / 60 + coords[2] / 3600
+    if ref == "S" or ref == "W":
+        decimal_degrees = -decimal_degrees
+    return round(decimal_degrees, 5)
+
+
+def extract_location(filepath: str) -> dict:
+    """Get location data from image
+
+    ### Args:
+        * filepath (`str`): Path to file location
+
+    ### Returns:
+        * dict: `{ "lng": float, "lat": float, "alt": float }`
+    """
+
+    output = {"lng": 0.0, "lat": 0.0, "alt": 0.0}
+
+    with open(filepath, "rb") as src:
+        img = Image(src)
+
+    if img.has_exif is False:
+        return output
+
+    try:
+        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,38 +1,43 @@
 from importlib.util import module_from_spec, spec_from_file_location
 from os import getcwd, path, walk
+from pathlib import Path
+
+# =================================================================================
 
-#=================================================================================
 
 # Import functions
 # Took from https://stackoverflow.com/a/57892961
 def get_py_files(src):
-    cwd = getcwd() # Current Working directory
-    py_files = [] 
+    cwd = getcwd()  # Current Working directory
+    py_files = []
     for root, dirs, files in walk(src):
         for file in files:
             if file.endswith(".py"):
-                py_files.append(path.join(cwd, root, file))
+                py_files.append(Path(f"{cwd}/{root}/{file}"))
     return py_files
 
 
 def dynamic_import(module_name, py_path):
     try:
         module_spec = spec_from_file_location(module_name, py_path)
-        module = module_from_spec(module_spec) # type: ignore
-        module_spec.loader.exec_module(module) # type: ignore
+        module = module_from_spec(module_spec)  # type: ignore
+        module_spec.loader.exec_module(module)  # type: ignore
         return module
     except SyntaxError:
-        print(f"Could not load extension {module_name} due to invalid syntax. Check logs/errors.log for details.", flush=True)
+        print(
+            f"Could not load extension {module_name} due to invalid syntax. Check logs/errors.log for details.",
+            flush=True,
+        )
         return
     except Exception as exp:
         print(f"Could not load extension {module_name} due to {exp}", flush=True)
         return
 
 
-def dynamic_import_from_src(src, star_import = False):
+def dynamic_import_from_src(src, star_import=False):
     my_py_files = get_py_files(src)
     for py_file in my_py_files:
-        module_name = path.split(py_file)[-1][:-3]
+        module_name = Path(py_file).stem
         print(f"Importing {module_name} extension...", flush=True)
         imported_module = dynamic_import(module_name, py_file)
         if imported_module != None:
@@ -44,4 +49,5 @@ def dynamic_import_from_src(src, star_import = False):
         print(f"Successfully loaded {module_name} extension", flush=True)
     return
 
-#=================================================================================
+
+# =================================================================================

modules/hasher.py

@@ -1,55 +1,72 @@
-from modules.database import col_photos
+import cv2
 import numpy as np
 from numpy.typing import NDArray
 from scipy import spatial
-import cv2
+
+from modules.database import col_photos
+
 
 def hash_array_to_hash_hex(hash_array):
-  # 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())
-  return (hex(int(hash_str, 2)))
+    # 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())
+    return hex(int(hash_str, 2))
+
 
 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)
+    # 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)
+
 
 def get_duplicates_cache(album: str) -> dict:
     output = {}
-    for photo in col_photos.find( {"album": album} ):
+    for photo in col_photos.find({"album": album}):
         output[photo["filename"]] = [photo["_id"].__str__(), photo["hash"]]
     return output
 
+
 async def get_phash(filepath: str) -> str:
     img = cv2.imread(filepath)
     # resize image and convert to gray scale
     img = cv2.resize(img, (64, 64))
     img = cv2.cvtColor(img, cv2.COLOR_BGR2GRAY)
-    img = np.array(img, dtype = np.float32)
-    # calculate dct of image 
+    img = np.array(img, dtype=np.float32)
+    # calculate dct of image
     dct = cv2.dct(img)
-    # to reduce hash length take only 8*8 top-left block 
+    # to reduce hash length take only 8*8 top-left block
     # as this block has more information than the rest
-    dct_block = dct[: 8, : 8]
+    dct_block = dct[:8, :8]
     # caclulate mean of dct block excluding first term i.e, dct(0, 0)
-    dct_average = (dct_block.mean() * dct_block.size - dct_block[0, 0]) / (dct_block.size - 1)
+    dct_average = (dct_block.mean() * dct_block.size - dct_block[0, 0]) / (
+        dct_block.size - 1
+    )
     # convert dct block to binary values based on dct_average
     dct_block[dct_block < dct_average] = 0.0
     dct_block[dct_block != 0] = 1.0
     # store hash value
     return hash_array_to_hash_hex(dct_block.flatten())
 
+
 async def get_duplicates(hash: str, album: str) -> list:
     duplicates = []
     cache = get_duplicates_cache(album)
     for image_name in cache.keys():
-        distance = spatial.distance.hamming(
-            hash_hex_to_hash_array(cache[image_name][1]), 
-            hash_hex_to_hash_array(hash)
-        )
-        print("{0:<30} {1}".format(image_name, distance), flush=True)
-        if distance <= 0.25:
-            duplicates.append({"id": cache[image_name][0], "filename": image_name, "difference": distance})
-    return duplicates
+        try:
+            distance = spatial.distance.hamming(
+                hash_hex_to_hash_array(cache[image_name][1]),
+                hash_hex_to_hash_array(hash),
+            )
+        except ValueError:
+            continue
+        # print("{0:<30} {1}".format(image_name, distance), flush=True)
+        if distance <= 0.1:
+            duplicates.append(
+                {
+                    "id": cache[image_name][0],
+                    "filename": image_name,
+                    "difference": distance,
+                }
+            )
+    return duplicates

modules/mailer.py

@@ -0,0 +1,41 @@
+import logging
+from smtplib import SMTP, SMTP_SSL
+from ssl import create_default_context
+from traceback import print_exc
+
+from modules.utils import configGet
+
+logger = logging.getLogger(__name__)
+
+try:
+    if configGet("use_ssl", "mailer", "smtp") is True:
+        mail_sender = SMTP_SSL(
+            configGet("host", "mailer", "smtp"),
+            configGet("port", "mailer", "smtp"),
+        )
+        logger.info("Initialized SMTP SSL connection")
+    elif configGet("use_tls", "mailer", "smtp") is True:
+        mail_sender = SMTP(
+            configGet("host", "mailer", "smtp"),
+            configGet("port", "mailer", "smtp"),
+        )
+        mail_sender.starttls(context=create_default_context())
+        mail_sender.ehlo()
+        logger.info("Initialized SMTP TLS connection")
+    else:
+        mail_sender = SMTP(
+            configGet("host", "mailer", "smtp"), configGet("port", "mailer", "smtp")
+        )
+        mail_sender.ehlo()
+        logger.info("Initialized SMTP connection")
+except Exception as exp:
+    logger.error("Could not initialize SMTP connection to: %s", exp)
+    print_exc()
+
+try:
+    mail_sender.login(
+        configGet("login", "mailer", "smtp"), configGet("password", "mailer", "smtp")
+    )
+    logger.info("Successfully initialized mailer")
+except Exception as exp:
+    logger.error("Could not login into provided SMTP account due to: %s", exp)

modules/scheduler.py

@@ -1,3 +1,3 @@
 from apscheduler.schedulers.asyncio import AsyncIOScheduler
 
-scheduler = AsyncIOScheduler()
+scheduler = AsyncIOScheduler()

modules/security.py

@@ -1,16 +1,13 @@
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import List, Union
-from modules.database import col_users
 
 from fastapi import Depends, HTTPException, Security, status
-from fastapi.security import (
-    OAuth2PasswordBearer,
-    SecurityScopes,
-)
+from fastapi.security import OAuth2PasswordBearer, SecurityScopes
 from jose import JWTError, jwt
 from passlib.context import CryptContext
 from pydantic import BaseModel, ValidationError
 
+from modules.database import col_users
 
 with open("secret_key", "r", encoding="utf-8") as f:
     SECRET_KEY = f.read()
@@ -52,7 +49,7 @@ oauth2_scheme = OAuth2PasswordBearer(
         "photos.write": "Modify photos.",
         "videos.list": "List videos.",
         "videos.read": "View videos.",
-        "videos.write": "Modify videos."
+        "videos.write": "Modify videos.",
     },
 )
 
@@ -66,8 +63,13 @@ def get_password_hash(password):
 
 
 def get_user(user: str):
-    found_user = col_users.find_one( {"user": user} )
-    return UserInDB(user=found_user["user"], email=found_user["email"], disabled=found_user["disabled"], hash=found_user["hash"])
+    found_user = col_users.find_one({"user": user})
+    return UserInDB(
+        user=found_user["user"],
+        email=found_user["email"],
+        disabled=found_user["disabled"],
+        hash=found_user["hash"],
+    )
 
 
 def authenticate_user(user_name: str, password: str):
@@ -79,19 +81,22 @@ def authenticate_user(user_name: str, password: str):
     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):
     to_encode = data.copy()
     if expires_delta:
-        expire = datetime.utcnow() + expires_delta
+        expire = datetime.now(tz=timezone.utc) + expires_delta
     else:
-        expire = datetime.utcnow() + timedelta(days=ACCESS_TOKEN_EXPIRE_DAYS)
+        expire = datetime.now(tz=timezone.utc) + timedelta(
+            days=ACCESS_TOKEN_EXPIRE_DAYS
+        )
     to_encode.update({"exp": expire})
     encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
     return encoded_jwt
 
 
-async def get_current_user( security_scopes: SecurityScopes, token: str = Depends(oauth2_scheme) ):
-
+async def get_current_user(
+    security_scopes: SecurityScopes, token: str = Depends(oauth2_scheme)
+):
     if security_scopes.scopes:
         authenticate_value = f'Bearer scope="{security_scopes.scope_str}"'
     else:
@@ -112,7 +117,7 @@ async def get_current_user( security_scopes: SecurityScopes, token: str = Depend
         token_data = TokenData(scopes=token_scopes, user=user)
     except (JWTError, ValidationError):
         raise credentials_exception
-        
+
     user = get_user(user=token_data.user)
 
     if user is None:
@@ -128,7 +133,9 @@ async def get_current_user( security_scopes: SecurityScopes, token: str = Depend
     return user
 
 
-async def get_current_active_user( current_user: User = Security(get_current_user, scopes=["me"]) ):
+async def get_current_active_user(
+    current_user: User = Security(get_current_user, scopes=["me"])
+):
     if current_user.disabled:
         raise HTTPException(status_code=400, detail="Inactive user")
-    return current_user
+    return current_user

modules/utils.py

@@ -1,49 +1,59 @@
+import logging
+from pathlib import Path
+from traceback import format_exc
 from typing import Any, Union
-from ujson import loads, dumps, JSONDecodeError
-from traceback import print_exc
 
-# Print to stdout and then to log
-def logWrite(message: str, debug: bool = False) -> None:
-    # save to log file and rotation is to be done
-    # logAppend(f'{message}', debug=debug)
-    print(f"{message}", flush=True)
+from ujson import JSONDecodeError, dumps, loads
 
-def jsonLoad(filepath: str) -> Any:
+logger = logging.getLogger(__name__)
+
+
+def jsonLoad(filepath: Union[str, Path]) -> Any:
     """Load json file
 
     ### Args:
-        * filepath (`str`): Path to input file
+        * filepath (`Union[str, Path]`): Path to input file
 
     ### Returns:
         * `Any`: Some json deserializable
-    """    
-    with open(filepath, "r", encoding='utf8') as file:
+    """
+    with open(filepath, "r", encoding="utf8") as file:
         try:
             output = loads(file.read())
         except JSONDecodeError:
-            logWrite(f"Could not load json file {filepath}: file seems to be incorrect!\n{print_exc()}")
+            logger.error(
+                "Could not load json file %s: file seems to be incorrect!\n%s",
+                filepath,
+                format_exc(),
+            )
             raise
         except FileNotFoundError:
-            logWrite(f"Could not load json file {filepath}: file does not seem to exist!\n{print_exc()}")
+            logger.error(
+                "Could not load json file %s: file does not seem to exist!\n%s",
+                filepath,
+                format_exc(),
+            )
             raise
         file.close()
     return output
 
-def jsonSave(contents: Union[list, dict], filepath: str) -> None:
+
+def jsonSave(contents: Union[list, dict], filepath: Union[str, Path]) -> None:
     """Save contents into json file
 
     ### Args:
         * contents (`Union[list, dict]`): Some json serializable
-        * filepath (`str`): Path to output file
-    """    
+        * filepath (`Union[str, Path]`): Path to output file
+    """
     try:
-        with open(filepath, "w", encoding='utf8') as file:
+        with open(filepath, "w", encoding="utf8") as file:
             file.write(dumps(contents, ensure_ascii=False, indent=4))
             file.close()
     except Exception as exp:
-        logWrite(f"Could not save json file {filepath}: {exp}\n{print_exc()}")
+        logger.error("Could not save json file %s: %s\n%s", filepath, exp, format_exc())
     return
 
+
 def configGet(key: str, *args: str) -> Any:
     """Get value of the config key
 
@@ -53,23 +63,25 @@ def configGet(key: str, *args: str) -> Any:
 
     ### Returns:
         * `Any`: Value of provided key
-    """    
-    this_dict = jsonLoad("config.json")
+    """
+    this_dict = jsonLoad(Path("config.json"))
     this_key = this_dict
     for dict_key in args:
         this_key = this_key[dict_key]
     return this_key[key]
 
+
 def apiKeyInvalid(obj):
     obj.send_response(401)
-    obj.send_header('Content-type', 'application/json; charset=utf-8')
+    obj.send_header("Content-type", "application/json; charset=utf-8")
     obj.end_headers()
     obj.wfile.write(b'{"code":401, "message": "Invalid API key"}')
     return
 
+
 def apiKeyExpired(obj):
     obj.send_response(403)
-    obj.send_header('Content-type', 'application/json; charset=utf-8')
+    obj.send_header("Content-type", "application/json; charset=utf-8")
     obj.end_headers()
     obj.wfile.write(b'{"code":403, "message": "API key expired"}')
-    return
+    return

pages/home/style.css

@@ -1,3 +1,5 @@
+@import url('https://fonts.cdnfonts.com/css/google-sans');
+
 /* Material Customization */
 :root {
     --pure-material-primary-rgb: 255, 191, 0;
@@ -15,15 +17,15 @@ body {
 .registration {
     position: relative;
     border-radius: 8px;
-    padding: 16px 48px;
+    padding: 16px 48px 30px 30px;
     box-shadow: 0 3px 1px -2px rgba(0, 0, 0, 0.2), 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12);
     overflow: hidden;
     background-color: white;
 }
 
-h1 {
+.registration h1 {
     margin: 32px 0;
-    font-family: "Roboto", "Segoe UI", BlinkMacSystemFont, system-ui, -apple-system;
+    font-family: 'Product Sans', sans-serif;
     font-weight: normal;
     text-align: center;
 }
@@ -35,114 +37,69 @@ h1 {
 }
 
 p {
-    font-family: "Roboto", "Segoe UI", BlinkMacSystemFont, system-ui, -apple-system;
+    font-family: 'Product Sans', sans-serif;
     font-weight: normal;
     text-align: center;
+    color: #2b2b2b;
 }
 
 a.matter-button-contained {
+    font-family: 'Product Sans', sans-serif;
     text-decoration: none;
 }
 
 a {
     color: rgb(var(--pure-material-primary-rgb));
+    font-family: 'Product Sans', sans-serif;
     text-decoration: none;
 }
 
 a:hover {
-    text-decoration: underline;
-}
-
-button {
-    display: block !important;
-    margin: 32px auto;
-}
-
-.done,
-.progress {
-    position: absolute;
-    top: 0;
-    bottom: 0;
-    left: 0;
-    right: 0;
-    display: flex;
-    flex-direction: column;
-    align-items: center;
-    justify-content: center;
-    background-color: white;
-    visibility: hidden;
-}
-
-.done {
-    transition: visibility 0s 1s;
-}
-
-.signed > .done {
-    visibility: visible;
-}
-
-.done > a {
-    display: inline-block;
     text-decoration: none;
 }
 
-.progress {
-    opacity: 0;
+.matter-button-contained {
+    margin-top: 10px;
 }
 
-.signed > .progress {
-    animation: loading 4s;
-}
+@media only screen and (max-width: 980px) {
 
-@keyframes loading {
-    0% {
-        visibility: visible;
+    .registration {
+        position: fixed;
+        border-radius: none;
+        padding: auto;
+        box-shadow: none;
+        overflow: visible;
     }
-    12.5% {
-        opacity: 0;
+
+    .registration {
+        width: 95%;
+        height: auto;
     }
-    25% {
-        opacity: 1;
+
+    .registration h1 {
+        font-size: 64px;
     }
-    87.5% {
-        opacity: 1;
+
+    body {
+        background: none;
+        min-height: 85vh;
     }
-    100% {
-        opacity: 0;
+
+    p {
+        font-size: 42px;
     }
-}
 
-.left-footer,
-.right-footer {
-    position: fixed;
-    padding: 14px;
-    bottom: 14px;
-    color: #555;
-    background-color: #eee;
-    font-family: "Roboto", "Segoe UI", BlinkMacSystemFont, system-ui, -apple-system;
-    font-size: 14px;
-    line-height: 1.5;
-    box-shadow: 0 3px 1px -2px rgba(0, 0, 0, 0.2), 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12);
-}
+    .matter-button-contained {
+        padding-top: 0.5em;
+        padding-bottom: 1.3em;
+        padding-left: 0.65em;
+        padding-right: 0.65em;
+        border-radius: 7px;
+    }
 
-.left-footer {
-    left: 0;
-    border-radius: 0 4px 4px 0;
-    text-align: left;
-}
+    a.matter-button-contained {
+        font-size: 3.2em;
+    }
 
-.right-footer {
-    right: 0;
-    border-radius: 4px 0 0 4px;
-    text-align: right;
-}
-
-.left-footer > a,
-.right-footer > a {
-    color: black;
-}
-
-.left-footer > a:hover,
-.right-footer > a:hover {
-    text-decoration: underline;
 }

pages/register/index.html

@@ -4,26 +4,28 @@
   <meta charset="UTF-8">
   <title>END PLAY Photos API • Sign Up</title>
   <link href="/pages/matter.css" rel="stylesheet">
-  <link rel="stylesheet" href="/pages/home/style.css">
+  <link rel="stylesheet" href="/pages/register/style.css">
 </head>
 
 <body>
 <!-- partial:index.partial.html -->
-<form class="registration" method="post">
+<iframe name="hiddenFrame" width="0" height="0" border="0" style="display: none;"></iframe>
+
+<form class="registration" method="post" action="/users" enctype="application/x-www-form-urlencoded" target="hiddenFrame">
   <h1>👋 Welcome!</h1>
 
   <label class="matter-textfield-outlined">
-     <input placeholder=" " type="text" alt="You won't be able to change it later!" required>
+     <input placeholder=" " type="text" alt="You won't be able to change it later!" id="user" name="user" required>
       <span>Username</span>
   </label>
 
   <label class="matter-textfield-outlined">
-     <input placeholder=" " type="email" required>
+     <input placeholder=" " type="email" id="email" name="email" required>
       <span>Email</span>
   </label>
 
   <label class="matter-textfield-outlined">
-    <input placeholder=" " type="password" required>
+    <input placeholder=" " type="password" id="password" name="password" required>
     <span>Password</span>
   </label>
 
@@ -32,11 +34,14 @@
     <span>I agree to the <a href="https://codepen.io/collection/nZKBZe/" target="_blank" title="Actually not a Terms of Service">Terms of Service</a></span>
   </label>
 
-  <button class="matter-button-contained" type="submit">Sign Up</button>
+  <center><a class="matter-button-contained" href="https://photos.end-play.xyz/register" type="submit" value="Submit">Sign Up</a></center>
+  <!-- <button class="matter-button-contained" type="submit" value="Submit">Sign Up</button> -->
 
   <div class="done">
     <h1>👌 You're all set!</h1>
-    <a class="matter-button-text" href="javascript:window.location.reload(true)">Again</a>
+    <p>You should now receive an email with activation link.</p>
+    <p>Activate your account and proceed to docs if you'd like to learn how to use API now.</p>
+    <a class="matter-button-text" href="/docs">Docs</a>
   </div>
   <div class="progress">
     <progress class="matter-progress-circular" />
@@ -44,7 +49,7 @@
 </form>
 
 <!-- partial -->
-  <script  src="./script.js"></script>
+  <script  src="/pages/register/script.js"></script>
 
 </body>
 </html>

pages/register/script.js

@@ -3,4 +3,5 @@ var form = document.querySelector('form');
 form.onsubmit = function (event) {
     event.preventDefault();
     form.classList.add('signed');
+    form.submit();
 };

pages/register/style.css

@@ -61,6 +61,9 @@ button {
     justify-content: center;
     background-color: white;
     visibility: hidden;
+    padding-left: 40px;
+    padding-right: 40px;
+    text-align: center;
 }
 
 .done {
@@ -81,7 +84,7 @@ button {
 }
 
 .signed > .progress {
-    animation: loading 4s;
+    animation: loading 3s;
 }
 
 @keyframes loading {
@@ -135,4 +138,55 @@ button {
 .left-footer > a:hover,
 .right-footer > a:hover {
     text-decoration: underline;
+}
+
+@media only screen and (max-width: 980px) {
+
+    .registration {
+        width: 90%;
+        height: auto;
+        position: fixed;
+        border-radius: none;
+        padding: auto;
+        box-shadow: none;
+        overflow: visible;
+    }
+
+    body {
+        background: none;
+        min-height: 85vh;
+    }
+
+    p {
+        font-size: 36px;
+    }
+
+    .registration h1 {
+        font-size: 64px;
+    }
+    
+    .matter-button-contained {
+        padding-top: 0.5em;
+        padding-bottom: 1.3em;
+        padding-left: 0.65em;
+        padding-right: 0.65em;
+        border-radius: 7px;
+    }
+    
+    .matter-button-text {
+        padding-top: 0.4em;
+        padding-bottom: 1.3em;
+        padding-left: 0.65em;
+        padding-right: 0.65em;
+        border-radius: 7px;
+    }
+
+    a.matter-button-contained {
+        font-size: 3.2em;
+    }
+
+    a.matter-button-text {
+        font-size: 2.6em;
+    }
+
 }

photos_api.py

@@ -1,11 +1,20 @@
-from os import makedirs, sep
-from modules.app import app
-from modules.utils import *
-from modules.scheduler import scheduler
-from modules.extensions_loader import dynamic_import_from_src
+import logging
+from os import makedirs
+from pathlib import Path
+
 from fastapi.responses import FileResponse
 
-makedirs(f"data{sep}users", exist_ok=True)
+from modules.app import app
+from modules.extensions_loader import dynamic_import_from_src
+from modules.scheduler import scheduler
+
+makedirs(Path("data/users"), exist_ok=True)
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(name)s.%(funcName)s | %(levelname)s | %(message)s",
+    datefmt="[%X]",
+)
 
 
 @app.get("/favicon.ico", response_class=FileResponse, include_in_schema=False)
@@ -13,8 +22,8 @@ async def favicon():
     return FileResponse("favicon.ico")
 
 
-#=================================================================================
-dynamic_import_from_src("extensions", star_import = True)
-#=================================================================================
+# =================================================================================
+dynamic_import_from_src("extensions", star_import=True)
+# =================================================================================
 
-scheduler.start()
+scheduler.start()

requirements.txt

@@ -1,9 +1,11 @@
-fastapi[all]
-pymongo==4.3.3
-ujson~=5.6.0
-scipy~=1.9.3
-python-magic~=0.4.27
-opencv-python~=4.6.0.66
-python-jose[cryptography]~=3.3.0
+aiofiles==23.1.0
+apscheduler~=3.10.1
+exif==1.6.0
+fastapi[all]==0.98.0
+opencv-python~=4.7.0.72
 passlib~=1.7.4
-apscheduler~=3.9.1.post1
+pymongo==4.4.0
+python-jose[cryptography]~=3.3.0
+python-magic~=0.4.27
+scipy~=1.10.1
+ujson~=5.8.0