vabe / decaff

Online gallery for browsing, uploading and interacting with images based on the CAFF (CrySyS Animated File Format) format.

deCAFF

Online gallery for browsing, uploading and interacting with images based on the CAFF (CrySyS Animated File Format) format.

⚙️ Prerequisites

• node (tested with v16.15.0)
• yarn (tested with 1.22.5)
• python (tested with 3.10.8)
• MinGW (tested with 12.1.0)
• Docker (tested with 20.10.17)

⏳ Installation

⚠: Before running any of the commands, make sure to define the .env files and their values in the ./frontend and ./backend packages. Example values and the required keys can be found in their corresponding README.md files.

To install and start up the stack, run the following commands in order:

# From the root
# Parser initialisation
pip install -r .\requirements.txt
python api.py

# Backend initialisation
cd .\backend\

# install dependencies
yarn

# initialise db
# starts a docker container with PostgreSQL,
# runs all previous migrations, and generates prisma types
yarn db:init

# start backend
yarn dev

# Go back to root
cd ..

# Frontend
cd .\frontend\

# install dependencies
yarn

# start frontend
yarn dev

📖 Documentation

Please refer to the README in each package for package-specific information, and the Wiki for structural view.

📚 References

• NestJS: Node.js framework for building efficient, reliable and scalable server-side applications
• File up- and download: Nest provides a built-in module based on the multer middleware package for Express
• Flask: a micro web framework written in Python
• python subprocess: allows spawning new processes, connecting to their input/output/error pipes, and obtaining their return codes
• PostgreSQL: a powerful, open source object-relational database system
• MUI: comprehensive suite of UI tools and components, highly customizable
• ReactQuery: asynchronous state management that supports stale-while-revalidate caching mechanism
• axios: promise-based HTTP client
• lodash: JS utility library
• msw: next generation mocking that intercepts requests on the network level
• prettier: opinionated code formatter

decaff's Issues

Convert CIFFs to (PNG)->PPM

Integrate front- and backend

Consolidate the frontend application with the backend application, initially without any meaningful data transfer happening between the two entities. The goal of this issue is to have the two parts be represented in the same location to improve velocity.

CAFF parsing

Create Makefile

Create the Makefile for the c++ application to be able to compile

C++ application JS compatibility

Research and implement the C++ NodeJS compatibility

C++ secure coding

Find the C++ secure coding notes and implement them in the application

CAFF parser security checks

• header id = 1
• header length = length of data
• magic = CAFF
• header_size = header length = length of the whole header data
• credit id = 2
• credit length = data length
• creator_len = len(creator ASCII(
• animation id = 3
• length = data length
• year > 1900

Init C++ app

Skeleton + first steps + documentation

Resolve issues generated by static analysis

Fix all mentioned issues and warning that are truly problematic.

CIFF parser security checks

• magic = CIFF
• header_size = whole CIFF header length
• content_size = width x height x 3 (can be 0)
• caption ends with \n
• tags end with \0
• content pixels RGB are in range 1-255

CIFF parsing

Create frontend package

Initialise frontend package with all the necessary dependencies and basic configuration files.