Global code review

.env.example

@@ -0,0 +1,8 @@
+POSTGREST_API=http://postg-rest:3000
+DETAILED_ERRORS=false
+
+ESP_PATH=./esp32/config
+DB_PATH=./database/data
+
+JWT_SECRET=
+POSTGRES_PASSWORD=

.gitignore

@@ -0,0 +1,6 @@
+.idea/
+# vim backup files
+*.sw[pon]
+.env
+# nohup
+nohup.out

Dockerfile/Dockerfile.Nginx

@@ -0,0 +1,19 @@
+# node 20, build the application
+FROM node:20.12.2-alpine3.19
+COPY ../Interface .
+RUN npm install
+RUN npm run build
+
+
+# nginx 1.26 on port 80, keep the build output, nginx config
+FROM nginx:1.26-alpine-otel
+EXPOSE 80
+COPY --from=0 ../dist /var/www/memoires-info/html
+COPY ../.env /var/www/memoires-info/html/.env
+
+# copy the nginx config
+COPY ../nginx.conf /etc/nginx/conf.d/default.conf
+RUN sed -i '/location \/adminer\//,/}/d' /etc/nginx/conf.d/default.conf
+# copy php files for ngnix to know they exist
+COPY ../php/public /var/www/memoires-info/php/public
+

Dockerfile/Dockerfile.Php

@@ -0,0 +1,13 @@
+# php 8.3 with the files, install dependencies
+FROM composer:2.7
+COPY ../php .
+RUN composer install
+
+# copy required files to new image
+FROM php:8.3-fpm-alpine
+COPY ../php/public /var/www/memoires-info/php/public
+COPY ../php/private /var/www/memoires-info/php/private
+COPY ../php/lib.php /var/www/memoires-info/php
+COPY ../.env /var/www/memoires-info/php/
+COPY --from=0 ../app/vendor /var/www/memoires-info/php/vendor
+

Dockerfile/Dockerfile.Sqitch

@@ -0,0 +1,3 @@
+FROM sqitch/sqitch:v1.4.1.0
+CMD ["deploy"]
+

README.md

@@ -1,2 +1,116 @@
-# climat_guardian
-Système de surveillance climatique 
+[Info]: <> (
+	All the information that are likely to need to be updated have a comment above them like this one
+)
+# Climate-Guardian
+This project was made for the non-profit organization memoires-informatiques\
+Memoires-informatiques has a lot of old computers and other electronic devices that need to be stored in a controlled environment\
+The goal of this project is to monitor the temperature and humidity of the different rooms of the organization and to display the data on a web interface
+
+# Setup
+From now on, the computer that runs the docker will be called "server" and
+the computer used by the user will be called "computer"
+
+## Network
+The server and the esp need to be connected to the same network, it is recommended to give both of them a static ip address\
+The computer can be connected from any network as long as the network has open ports, otherwise you'll have to be on the same network as the server
+
+![hardware](/.assets/hardware-diagram.png)\
+![software](/.assets/software-diagram.png)
+
+## Requirements
+For this project to work you need to have the following installed on the server:
+- Linux (Tested on [Ubuntu Server 22.04](https://ubuntu.com/download/server))
+- [Docker Engine](https://docs.docker.com/engine/install/ubuntu/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- [Curl](https://curl.se/download.html)
+- [jq](https://stedolan.github.io/jq/download/)
+```bash
+sudo apt-get update
+sudo apt-get install git curl jq 
+sudo apt-get install ca-certificates
+sudo install -m 0755 -d /etc/apt/keyrings
+sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
+sudo chmod a+r /etc/apt/keyrings/docker.asc
+echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+sudo apt-get update
+sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
+```
+
+## Installation
+First thing you need to do is to clone the repository from GitHub on the server
+```bash
+git clone https://github.com/museebolo/climat-guardian.git && cd climat-guardian
+```
+
+---
+[Info]: <> (
+	This is the list of all the files that end with .example
+)
+Once the repository is cloned you can remove the `.example` at the end of the following files:
+- .env.example
+- esp32/config/secrets.yaml.example
+- Interface/src/contexts/SampleContext.example.tsx
+```bash
+cp .env.example .env
+cp esp32/config/secrets.yaml.example esp32/config/secrets.yaml
+cp Interface/src/contexts/SampleContext.example.tsx Interface/src/contexts/SampleContext.tsx
+```
+
+---
+Now you want to generate a secret key for the jwt tokens used by the api
+```bash
+sed -i '/JWT_SECRET/d' .env
+echo "JWT_SECRET=$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)" >> .env
+```
+
+You may also want to generate a random password for the database
+```bash
+sed -i '/POSTGRES_PASSWORD/d' .env
+echo "POSTGRES_PASSWORD=$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)" >> .env
+```
+
+It is recommended to let the other environment variables as they are
+
+---
+Finally, you **have to** fill the Wi-Fi credentials in `esp32/config/secrets.yaml`\
+You also **have to** change the `127.0.0.1` in `Interface/src/contexts/SampleContext.tsx` and `esp32/config/secrets.yaml` by the ip address of the server
+
+## Start the project
+Once everything is configured on the server, you can start the project by running the docker compose on the server
+```bash
+docker compose -f docker-compose.prod.yml up -d --remove-orphans --build
+```
+Once the docker is running you can access the web interface by going to the ip address of the server in the web browser of the computer\
+the default user is `admin` and has `admin` as password
+
+![web interface](/.assets/dashboard.png)
+
+## ESP 32 Installation
+This project uses [esp home](https://github.com/esphome/esphome) to manage the esp32, you can configure the esp32 by following the instructions below
+- Connect yourself to the esp home interface by going to `127.0.0.1/esp` in the web browser of the computer (replace `127.0.0.1` with the ip address of the server)
+- Plug the esp32 to the server
+- Press the `+ NEW DEVICE` button inside esp home
+- Name your device
+- Select `ESP32` (on the top of the list)
+- Press `INSTALL` and select `Plug into the computer running ESPHome Dashboard` (the 3rd option)
+- Select the device with ``/dev/ttyUSB0`` as path
+- Wait for the installation to finish\
+Be sure to memorize the ip address of the esp32 (you can find it in the logs)
+$${\color{gray} \text{[15:39:12]} \color{magenta} \text{[C][wifi:416]:   IP Address: 172.16.5.65}}$$
+- You can now unplug the esp32 and plug it to any other power source
+- Press `Edit` at the bottom of the logs
+- Copy everything from the line 31 of the file `esp32/esp32.yaml` on the server and paste it at the end of your esp32's configuration file
+```bash
+clear && cat esp32/esp32.yaml | sed -n '31,$p'
+```
+- Replace the XXX... at the end of the code with the token of your esp32\
+you can generate this token by running the following command on the server (replace `255.255.255.255` with the ip address of the esp32)
+```bash
+export TOKEN=$(curl 'http://127.0.0.1/php/login.php' -d '{"username":"admin","password":"admin"}' -X POST | jq '.token' -r)
+curl -H "Authorization: Bearer $TOKEN" "http://127.0.0.1/php/esp.php" -d '{"ip":"255.255.255.255"}' -X POST | jq '.token' -r
+```
+- Press `INSTALL` and select `Wirelessly` (the 1st option)
+- Wait for the installation to finish
+- Press `STOP` to exit the logs
+

database/.gitignore

@@ -0,0 +1 @@
+data

database/migration/deploy/data.sql

@@ -0,0 +1,56 @@
+-- Deploy climat-guardian:data to pg
+
+BEGIN;
+
+        create table api.data (
+                temperature real,
+                humidity real,
+                timestamp timestamp NOT NULL,
+                ip character varying(15) NOT NULL
+        );
+        grant select on api.data to web_user;
+
+        -- convert unix timestamp to timestamp and insert it
+        create or replace function api.insert_data(
+                temperature real,
+                humidity real,
+                ip varchar(15),
+                unix_timestamp bigint
+        ) 
+        returns void as $$
+        begin
+                -- if the ip said in the token is not the same as the one in the request, then this means that the user is not who he pretends to be and we should throw an error
+                if (current_setting('request.jwt.claims', true)::json->>'ip' != ip) then
+                        raise exception insufficient_privilege
+                        using hint = 'You are not who you pretend to be';
+                end if;
+                -- insert the data
+                insert into api.data("temperature", "humidity", "ip", "timestamp") values (temperature, humidity, ip, to_timestamp(unix_timestamp));
+        end $$ language plpgsql;
+        grant insert on api.data to esp32;
+
+        -- create a function to get the average temperature and humidity of each delta time
+        create function api.avg_date(
+                delta varchar
+        )
+        returns table(
+                avg_temperature double precision, 
+                avg_humidity double precision, 
+                date timestamp,
+                ip character varying(15),
+                count bigint
+        ) as $$
+        begin
+                return query select 
+                avg(temperature) as avg_temperature, 
+                avg(humidity) as avg_humidity,
+                date_trunc(delta, timestamp) as date,
+                data.ip,
+                count(*) as count
+                from api.data
+                group by date, data.ip
+                order by date;
+        end;
+        $$ language plpgsql;
+
+COMMIT;

database/migration/deploy/postgrest.sql

@@ -0,0 +1,8 @@
+-- Deploy climat-guardian:postgrest to pg
+
+BEGIN;
+
+        create schema api;
+        create role authenticator noinherit login password 'mysecretpassword';
+
+COMMIT;

database/migration/deploy/roles.sql

@@ -0,0 +1,25 @@
+-- Deploy climat-guardian:roles to pg
+
+BEGIN;
+
+        -- anonymous role
+        create role web_anon nologin;
+        grant usage on schema api to web_anon;
+        grant web_anon to authenticator;
+
+        -- create role for the esp 32
+        create role esp32 nologin;
+        grant usage on schema api to esp32;
+        grant esp32 to authenticator;
+
+        -- create role for the users
+        create role web_user nologin;
+        grant usage on schema api to web_user;
+        grant web_user to authenticator;
+
+        -- create a role for the login
+        create role web_login nologin;
+        grant usage on schema api to web_login;
+        grant web_login to authenticator;
+
+COMMIT;

database/migration/deploy/user.sql

@@ -0,0 +1,18 @@
+-- Deploy climat-guardian:user to pg
+
+BEGIN;
+
+        create table api.users (
+                id serial primary key,
+                username character varying(50) NOT NULL UNIQUE,
+                password character varying(60) NOT NULL
+        );
+
+        grant usage, select on sequence api.users_id_seq to web_user;
+        grant insert on api.users to web_user; -- any user can add new users
+        grant select on api.users to web_login;
+
+        -- create first user to be able to connect first time
+        insert into api.users(username, password) values ('admin', '$2y$10$vJMf8H4u0f913VOJJDqVIeYrqnZBSzgYZ3Zyoh76MDjf6ZlmNDKPu');
+
+COMMIT;

database/migration/revert/data.sql

@@ -0,0 +1,9 @@
+-- Revert climat-guardian:data from pg
+
+BEGIN;
+
+        drop table api.data;
+        drop function api.avg_date;
+        drop function api.insert_data;
+
+COMMIT;

database/migration/revert/postgrest.sql

@@ -0,0 +1,8 @@
+-- Revert climat-guardian:postgrest from pg
+
+BEGIN;
+
+        drop schema api;
+        drop role authenticator;
+
+COMMIT;

database/migration/revert/roles.sql

@@ -0,0 +1,21 @@
+-- Revert climat-guardian:roles from pg
+
+BEGIN;
+
+        -- anonymous role
+        revoke usage on schema api from web_anon;
+        drop role web_anon;
+
+        -- esp 32
+        revoke usage on schema api from esp32;
+        drop role esp32;
+
+        -- users
+        revoke usage on schema api from web_user;
+        drop role web_user;
+
+        -- login
+        revoke usage on schema api from web_login;
+        drop role web_login;
+
+COMMIT;

database/migration/revert/user.sql

@@ -0,0 +1,7 @@
+-- Revert climat-guardian:user from pg
+
+BEGIN;
+
+        drop table api.users;
+
+COMMIT;