feat: First commit

.dockerignore

@@ -0,0 +1 @@
+env/

.gitignore

@@ -0,0 +1,7 @@
+env/
+__pycache__/
+.env
+temp/*
+
+# Keep the .gitkeep file in the temp/ directory
+!.gitkeep

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.11.7-slim-bookworm
+
+WORKDIR /app
+
+COPY ./requirements.txt /app
+
+RUN pip install -r requirements.txt
+
+COPY . /app
+
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80", "--reload"]

README.md

@@ -0,0 +1,65 @@
+<div style="width:100%;display:flex;flex-direction:column;justify-content:center;align-items:center">
+<img style="width:80px"
+src="https://seeklogo.com/images/G/google-developers-logo-F8BF3155AC-seeklogo.com.png" alt="logo"/>
+</div>
+<h3 style="text-align:center">Google Developer Student Clubs - FPT University Da Nang</h3>
+
+# AI Services
+
+![version](https://img.shields.io/badge/version-0.1.1-green)
+![release](https://img.shields.io/badge/release-0.1.0-blue)
+
+## ✨ Available Services
+
+## ⏩ Forwarding Server
+
+The forwarding server help adding children server for processing. The parent server acts as a controller for load balancing.
+
+```bash
+# Specifying forwarding server by query params `fw`
+curl --location 'https://{api-endpoint}/?fw=0' --request 'POST'
+
+# Auto forwarding server. The parent server will controll loading balance among registered servers.
+curl --location 'https://{api-endpoint}/?fw=auto' --request 'POST'
+```
+
+- Get all registered forwarding servers.
+
+```bash
+curl --location 'https://{domain}/service/fw/' --request 'GET'
+```
+
+- Register forwarding server.
+
+```bash
+curl --location 'https://{domain}/service/fw/' --request 'POST' --data '{"url":"{children-base-domain}"}'
+```
+
+- Delete forwarding server.
+
+```bash
+curl --location 'https://{domain}/service/fw/' --request 'DELETE' --data '{"index":0}'
+```
+
+### Children Server Endpoint Request & Response
+
+- `/api/rembg/`
+
+```json
+// Request. Form-data
+{
+    "image": "<image-data>"
+}
+
+// Response. JSON
+{
+    "data": {
+        "image": "<static-access-url>"
+    }
+}
+```
+
+## 😊 Contributors
+
+- GDSC-FPTU [[gdsc-fptu](https://github.com/gdsc-fptu)]
+- Đoàn Quang Minh [[Ming-doan](https://github.com/Ming-doan)]

apps/apis/__init__.py

@@ -0,0 +1,13 @@
+from fastapi import APIRouter
+from .rembg import router as rembg_router
+from .img2text import router as img2text_router
+from .chats import router as chats_router
+from .fd import router as fd_router
+
+router = APIRouter(prefix='/api')
+
+# Register routes
+router.include_router(rembg_router)
+router.include_router(img2text_router)
+router.include_router(chats_router)
+router.include_router(fd_router)

apps/apis/chats/__init__.py

@@ -0,0 +1,33 @@
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse
+from fastapi.requests import Request
+
+router = APIRouter(prefix='/chats')
+router_base_configs = {
+    "tags": ["chats"],
+    "response_class": JSONResponse
+}
+
+
+# Message
+@router.post("/:conversation_id", **router_base_configs)
+def message():
+    return {"message": "Hello World"}
+
+
+# Get conversations
+@router.get("/get", **router_base_configs)
+def get_conversations():
+    return {"conversations": "Hello World"}
+
+
+# Create conversation
+@router.post("/create", **router_base_configs)
+def create_conversation():
+    return {"conversation_id": "Hello World"}
+
+
+# Delete conversation
+@router.delete("/delete", **router_base_configs)
+def delete_conversation():
+    return {"conversation": "Hello World"}

apps/apis/fd/__init__.py

@@ -0,0 +1,14 @@
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse
+
+router = APIRouter(prefix='/fd')
+router_base_configs = {
+    "tags": ["fd"],
+    "response_class": JSONResponse
+}
+
+
+# Face detection
+@router.post("/", **router_base_configs)
+def faces_detection():
+    return {"faces": "Hello World"}

apps/apis/img2text/__init__.py

@@ -0,0 +1,14 @@
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse
+
+router = APIRouter(prefix='/img2text')
+router_base_configs = {
+    "tags": ["img2text"],
+    "response_class": JSONResponse
+}
+
+
+# Image to text
+@router.post("/", **router_base_configs)
+def image_to_text():
+    return {"caption": "Hello World"}

apps/apis/rembg/__init__.py

@@ -0,0 +1,57 @@
+from fastapi import APIRouter, HTTPException, Depends
+from fastapi.responses import JSONResponse, StreamingResponse
+from apps.services.foward.fw_middleware import forward_middleware, forward_request
+from .models.rembg_model import RembgModel
+from .controllers.rembg_controller import rembg_controller
+from utils.local_storage import save_to_local, remove_from_local_with_expire
+
+router = APIRouter(prefix='/rembg')
+router_base_configs = {
+    "tags": ["rembg"],
+    "response_class": JSONResponse,
+}
+
+
+# Remove background
+@router.post("/", **router_base_configs)
+async def remove_background(
+    image: RembgModel.image = RembgModel.image_default,
+    stream: RembgModel.stream = RembgModel.stream_default,
+    expire: RembgModel.expire = RembgModel.expire_default,
+    fw_index: RembgModel.fw_index = Depends(forward_middleware)
+):
+    # Forward request
+    fw_data = {
+        "files": {"image": image.file}
+    }
+    fw_response = forward_request(fw_index, fw_data, '/api/rembg/')
+    if fw_response is not None:
+        return JSONResponse({
+            "message": "Image is processed successfully",
+            "access_link": fw_response["data"]['image']
+        })
+
+    # Check if image is None
+    if image is None:
+        raise HTTPException(status_code=400, detail="Image is required")
+    # Check if image is empty
+    if image.filename == '':
+        raise HTTPException(status_code=400, detail="Image is empty")
+    # Read image
+    image_bytes = await image.read()
+    # Process image
+    processed_image = await rembg_controller(image_bytes)
+    # If stream is True, return StreamingResponse
+    if RembgModel.stream_parser(stream):
+        return StreamingResponse(processed_image, media_type="application/octet-stream", headers={"Content-Disposition": f"attachment;filename={image.filename}"})
+    # If stream is False, save locally and return access link
+    else:
+        # Save image
+        local_path = save_to_local(processed_image.read(), image.filename)
+        # Automatic delete file
+        remove_from_local_with_expire(local_path, expire)
+        # Return access link
+        return JSONResponse({
+            "message": "Image is processed successfully",
+            "access_link": local_path
+        })

apps/apis/rembg/controllers/rembg_controller.py

@@ -0,0 +1,9 @@
+import rembg
+import io
+
+
+async def rembg_controller(image: bytes):
+    # Remove background
+    image = rembg.remove(image)
+    # Return image
+    return io.BytesIO(image)

apps/apis/rembg/models/rembg_model.py

@@ -0,0 +1,18 @@
+from fastapi import UploadFile, File, Form
+
+
+class RembgModel:
+    image = UploadFile | None
+    image_default = File(
+        None, description="Image to remove background", example="image.jpg")
+    stream = str | None
+    stream_default = Form(
+        None, description="Is return a streaming or access json", example="false")
+    expire = int | None
+    expire_default = Form(
+        None, description="Expire time of access link", example=3600)
+    fw_index = int | None
+    fw_index_default = Form(
+        None, description="Forward destination index", example=0)
+
+    def stream_parser(x): return False if x == 'false' or x == 0 else True

apps/create_app.py

@@ -0,0 +1,17 @@
+from fastapi import FastAPI
+from fastapi.staticfiles import StaticFiles
+from fastapi.middleware.cors import CORSMiddleware
+from utils.metadata import DOC_SWAGGER
+
+
+def create_app():
+    app = FastAPI(**DOC_SWAGGER)
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=['*'],
+        allow_credentials=True,
+        allow_methods=['*'],
+        allow_headers=['*'],
+    )
+    app.mount("/static", StaticFiles(directory="temp"), name="static")
+    return app

apps/services/__init__.py

@@ -0,0 +1,7 @@
+from fastapi import APIRouter
+from .foward import router as foward_router
+
+router = APIRouter(prefix='/service')
+
+# Register routes
+router.include_router(foward_router)

apps/services/foward/__init__.py

@@ -0,0 +1,31 @@
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse
+from .models.fw_model import CreateFwDestinationModel, DeleteFwDestinationModel
+from .fw_storage import get_fw_destinations, append_fw_destination, delete_fw_destination
+
+
+router = APIRouter(prefix='/fw')
+router_base_configs = {
+    "tags": ["fw"],
+    "response_class": JSONResponse
+}
+
+
+# Create foward destination
+@router.post("/", **router_base_configs)
+def create_forward_destination(data: CreateFwDestinationModel):
+    index = append_fw_destination(data.url)
+    return {"fw_index": index}
+
+
+# Delete foward destination
+@router.delete("/", **router_base_configs)
+def delete_forward_destination(data: DeleteFwDestinationModel):
+    delete_fw_destination(data.index)
+    return {"fw_index": data.index}
+
+
+# Get foward destinations
+@router.get("/", **router_base_configs)
+def get_forward_destinations():
+    return {"fw": get_fw_destinations()}

apps/services/foward/fw_middleware.py

@@ -0,0 +1,77 @@
+from typing import Any, Literal
+import requests
+from fastapi import HTTPException
+from .fw_storage import get_fw_destinations, update_fw_destination
+
+
+async def verify_fw_resources(url: str) -> bool:
+    try:
+        response = requests.get(url + '/health')
+        if response.status_code == 200:
+            return True
+        else:
+            return False
+    except Exception:
+        return False
+
+
+async def forward_middleware(fw: str = None):
+    # Verify forward destination index
+    try:
+        if fw != 'auto':
+            fw = int(fw)
+    except Exception:
+        raise HTTPException(
+            status_code=400, detail="Invalid forward destination")
+
+    # If forward destination is auto, get the destination with the least tasks
+    fw_destinations = get_fw_destinations()
+    if fw == 'auto':
+        if len(fw_destinations) != 0:
+            # Sort resources by tasks
+            fw_destinations.sort(key=lambda x: x['tasks'])
+            # Verify forward destination resources
+            fw = 0
+            for i in range(0, len(fw_destinations)):
+                is_resource_available = await verify_fw_resources(fw_destinations[fw]['url'])
+                if is_resource_available:
+                    fw = i
+                    break
+                else:
+                    fw = None
+            # Update forward destination tasks
+            if fw is not None:
+                update_fw_destination(fw, fw_destinations[fw]['tasks'] + 1)
+        else:
+            fw = None
+    # If forward destination is not auto, update forward destination tasks
+    else:
+        update_fw_destination(fw, fw_destinations[fw]['tasks'] + 1)
+
+    return fw
+
+
+def forward_request(fw_index: int, data: Any, endpoint: str = '', method: Literal['GET', 'POST', 'PUT', 'DELETE'] = 'POST'):
+    # Get forward destination url
+    fw_destinations = get_fw_destinations()
+    fw_url = fw_destinations[fw_index]['url'] + endpoint
+    # Call request
+    try:
+        if method == 'GET':
+            response = requests.get(fw_url)
+        elif method == 'POST':
+            response = requests.post(fw_url, **data)
+        elif method == 'PUT':
+            response = requests.put(fw_url, **data)
+        elif method == 'DELETE':
+            response = requests.delete(fw_url, **data)
+        else:
+            raise HTTPException(
+                status_code=400, detail="Invalid request method on forwarding request")
+    except Exception as e:
+        print("Forwarding Error: ", e)
+        response = None
+    # Update forward destination tasks
+    update_fw_destination(fw_index, fw_destinations[fw_index]['tasks'] - 1)
+    # Return response
+    return response.json() if response is not None else None

apps/services/foward/fw_storage.py

@@ -0,0 +1,46 @@
+from utils.local_storage import read_from_local, save_to_local
+
+
+FOWARD_JSON_FILE = 'forward.json'
+
+
+def get_fw_destinations() -> list:
+    destinations = read_from_local(FOWARD_JSON_FILE)
+    if destinations is None:
+        return []
+    return destinations
+
+
+def append_fw_destination(url: str):
+    # Remove the last / if exist
+    if url[-1] == '/':
+        url = url[:-1]
+    # Get forward destinations
+    forward_destinations = get_fw_destinations()
+    # Append new destination
+    forward_destinations.append({
+        "tasks": 0,
+        "url": url
+    })
+    # Save to local
+    save_to_local(forward_destinations, FOWARD_JSON_FILE, False)
+    # Return index
+    return len(forward_destinations) - 1
+
+
+def update_fw_destination(index: int, tasks: int):
+    # Get forward destinations
+    forward_destinations = get_fw_destinations()
+    # Update destination
+    forward_destinations[index]['tasks'] = tasks
+    # Save to local
+    save_to_local(forward_destinations, FOWARD_JSON_FILE, False)
+
+
+def delete_fw_destination(index: int):
+    # Get forward destinations
+    forward_destinations = get_fw_destinations()
+    # Delete destination
+    del forward_destinations[index]
+    # Save to local
+    save_to_local(forward_destinations, FOWARD_JSON_FILE, False)

apps/services/foward/models/fw_model.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+
+
+class CreateFwDestinationModel(BaseModel):
+    url: str = None
+
+
+class DeleteFwDestinationModel(BaseModel):
+    index: int = None

docker-compose.yaml

@@ -0,0 +1,13 @@
+version: '3.8'
+
+services:
+  api:
+    build: .
+    container_name: "gdsc-ai-service-container"
+    ports:
+      - "8000:80"
+    volumes:
+      - .:/app
+      - /app/env
+    env_file:
+      - .env

main.py

@@ -0,0 +1,18 @@
+# Google Developer Student Clubs - FPT University Da Nang
+import os
+import uvicorn
+from apps.create_app import create_app
+from apps.services.foward.fw_middleware import forward_middleware
+# Import routers
+from apps.apis import router as api_router
+from apps.services import router as service_router
+
+app = create_app()
+
+# Register apps routes
+app.include_router(api_router)
+app.include_router(service_router)
+
+# Config uvicorn
+if os.environ.get("ENV", "production") == 'development':
+    uvicorn.run(app, port=8000)

utils/constants.py

@@ -0,0 +1,38 @@
+import os
+
+APP_DOMAIN = "http://localhost:8000"
+
+TEMP_DIR = os.path.join(os.getcwd(), 'temp')
+
+DOC_TEMPLATE = f'''
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>GDSC AI Service</title>
+  </head>
+  <body>
+    <img src="https://seeklogo.com/images/G/google-developers-logo-F8BF3155AC-seeklogo.com.png" alt="logo" width="100">
+    <h1>GDSC AI Back-end Service</h1>
+    <span>Served URL: </span>
+    <a href="{APP_DOMAIN}">{APP_DOMAIN}</a>
+    <ul>
+      <li>Remove Background Service [POST]</li>
+      <code>{APP_DOMAIN}/api/rembg</code>
+    </ul>
+    <ul>
+      <li>Image to Text [POST]</li>
+      <code>{APP_DOMAIN}/api/img2text</code>
+    </ul>
+    <ul>
+      <li>Chats [POST]</li>
+      <code>{APP_DOMAIN}/api/chats</code>
+    </ul>
+    <ul>
+      <li>Face Detection [POST]</li>
+      <code>{APP_DOMAIN}/api/fd</code>
+    </ul>
+  </body>
+</html>
+'''

utils/local_storage.py

@@ -0,0 +1,81 @@
+from typing import Any
+import os
+import json
+from threading import Timer
+from .constants import TEMP_DIR, APP_DOMAIN
+
+
+def parse_filename(filename: str):
+    filename = filename.replace(' ', '_')
+    filename = filename.replace('(', '')
+    filename = filename.replace(')', '')
+    filename = filename.replace('[', '')
+    filename = filename.replace(']', '')
+    filename = filename.replace('{', '')
+    filename = filename.replace('}', '')
+    filename = filename.replace('<', '')
+    filename = filename.replace('>', '')
+    filename = filename.replace(';', '')
+    filename = filename.replace(':', '')
+    filename = filename.replace('"', '')
+    filename = filename.replace("'", '')
+    filename = filename.replace('\\', '')
+    filename = filename.replace('/', '')
+    filename = filename.replace('|', '')
+    filename = filename.replace('?', '')
+    filename = filename.replace('*', '')
+    # If file is exist, add number to filename
+    if os.path.isfile(os.path.join(TEMP_DIR, filename)):
+        filename = filename.split('.')
+        filename = f"{filename[0]}_1.{filename[1]}"
+    return filename
+
+
+def save_to_local(file: bytes | Any, filename: str, is_parse_filename: bool = True):
+    # Parse filename
+    if is_parse_filename:
+        filename = parse_filename(filename)
+    # Get type of file
+    file_extension = filename.split('.')[-1]
+    # Get write mode
+    if file_extension == 'json':
+        mode = 'w'
+    else:
+        mode = 'wb'
+    # Save file
+    with open(os.path.join(TEMP_DIR, filename), mode) as f:
+        if file_extension == 'json':
+            json.dump(file, f)
+        else:
+            f.write(file)
+    # Return access link
+    return f"{APP_DOMAIN}/static/{filename}"
+
+
+def read_from_local(filename: str):
+    # Get type of file
+    file_extension = filename.split('.')[-1]
+    # Get read mode
+    if file_extension == 'json':
+        mode = 'r'
+    else:
+        mode = 'rb'
+    # If file is exist, return file
+    if os.path.isfile(os.path.join(TEMP_DIR, filename)):
+        with open(os.path.join(TEMP_DIR, filename), mode) as f:
+            if file_extension == 'json':
+                return json.load(f)
+            return f.read()
+
+
+def remove_from_local(filename: str):
+    # If file is exist, add number to filename
+    if os.path.isfile(os.path.join(TEMP_DIR, filename)):
+        os.remove(os.path.join(TEMP_DIR, filename))
+
+
+def remove_from_local_with_expire(filename: str, expire: int):
+    # Remove file after expire time
+    if expire is not None and expire > 0:
+        t = Timer(expire, remove_from_local, args=[filename])
+        t.start()

utils/metadata.py

@@ -0,0 +1,34 @@
+DOC_SWAGGER = {
+    "title": "GDSC AI Service",
+    "description": "GDSC AI Back-end Service",
+    "version": "0.0.1",
+    "openapi": "3.0.2",
+    "info": {
+        "title": "GDSC AI Service",
+        "description": "GDSC AI Back-end Service",
+        "version": "0.0.1"
+    },
+    "docs_url": "/",
+    "openapi_tags": [
+        {
+            "name": "rembg",
+            "description": "Remove background from image"
+        },
+        {
+            "name": "img2text",
+            "description": "Extract text from image"
+        },
+        {
+            "name": "chats",
+            "description": "Chat with AI"
+        },
+        {
+            "name": "fd",
+            "description": "Detect faces from image"
+        },
+        {
+            "name": "fw",
+            "description": "Foward request to other services"
+        }
+    ]
+}