Hallvoice V3

.gitignore

@@ -1,7 +1,12 @@
 cache/
+logs/
 config.json
 config.ini
 .env
 .envrc
 .DS_Store
-.idea
+.idea
+__pycache__
+venv
+login.list
+firstname.list

Dockerfile.API

@@ -0,0 +1,5 @@
+FROM python:3.12
+LABEL authors="julien451"
+RUN pip3 install --no-cache redis
+
+ENTRYPOINT ["python3", "/hallvoice/purgeAPI.py", "/hallvoice/config/config.ini"]

Dockerfile.porte

@@ -0,0 +1,13 @@
+FROM debian:bookworm-slim
+LABEL authors="julien451"
+
+COPY requirements.txt .
+COPY asound.conf /etc/asound.conf
+RUN apt-get update --allow-releaseinfo-change
+RUN apt-get install alsa-utils python3-pip libglib2.0-0 libsm6 libxrender1 libxext6 --no-install-suggests --no-install-recommends -y
+RUN pip3 install --no-cache -r requirements.txt --break-system-packages
+
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+
+ENTRYPOINT ["python3", "/hallvoice/porte.py", "/hallvoice/conf/config.ini"]

README.md

@@ -1,13 +1,89 @@
 # Porte42 - Hall Voice
 Bonjour la porte
 
-## Requirements
+# Requirments
+## Studs
 - Buy Hall Voice Change on [intra shop](https://shop.intra.42.fr/)
 - Make a [Pull Request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) to add your files
-  - Add a .json file with your configuration
+  - Add a .json file with your configuration (Also see `custom/_Example.json`)
   - No sound during more than 10 seconds
   - No more than 20 sounds
   - No sound over 1 Mo
   - No troll, insults, too loud sound, etc
 
+PR might be refused if one of those requirements are missing
+
 You can find an example PR [here](https://github.com/42Paris/hall-voice/pull/3/files)
+
+## Staff
+- Buy one RPI and a pretty good audio speaker
+- In Raspbian, clone this repository
+- Goto the repository and type
+  - `pip3 install -r requirements.txt`
+- Install a Redis server
+  - `sudo apt-get install redis`
+- How to run?
+  - You can use systemctl
+    - `sudo cp hallvoice.service /etc/systemd/system`
+    - `sudo systemctl enable --now hallvoice.service`
+  - You can use Docker (WIP DO NOT USE ME, OR THE RPI WILL BURN)
+    - `docker-compose build --no-cache`
+    - `docker-compose up -d`
+- Copy and fill-up the config file in
+  - `cp config/config.ini.example config/config.ini`
+- Kafka:
+  - The RPI must be in bocal's network so it can access Redpanda
+  - You messages must be JSONised like so
+    - `{"building":"<where>","firstname":"<name>","kind":"<in/out>","login":"<login>"}`
+- You can pre-fill the redis cache with
+  - `goinfre-firstname-redis.py`
+    - to get all firstname from list of logins in `login.list`
+  - `goinfre-tts-redis.py`
+    - to cache all gTTS from a list of firstname in `firstname.list`
+      - This can take a very long time, generate one tts per second to avoid Google rate-limit
+- All data stored in redis have a TTL of 6 months
+
+# QnA
+## Studs
+- Q: Will the hallvoice use Usualname if I have one?
+  - A: Yes! Hallvoice use 42API to get your Usualname from your login, if there is no Usualname find, legal firstname will be used and cached
+- Q: I juste set a Usualname but the old legal firstname is still in use, how to "force" the hallvoice to use the my Usualname?
+  - A: Firstname is cached in Redis, you need to ask the bocal in [Slack](https://42born2code.slack.com/archives/C7P0Z4F3L) #42paris_staff_it or [Discord](https://discord.com/channels/774300457157918772/839426887171440671) #staff_it to purge it.
+- Q: I bought hallvoice, how to use it?
+  - A: As written in `Requirements`: You can find an example [PR](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) [here](https://github.com/42Paris/hall-voice/pull/3/files), also see `custom/_Example.json`
+- Q: I want to change a song, do I have to buy hallvoice again?
+  - A: No
+- Q: What's the TTL (Time to live) for the cache?
+  - A: TTL for redis cache is 6 month, the staff can change it in the config file
+- Q: Code is garbage, can I improve it?
+  - I guess... Yes you can? You can try to do a [PR](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork)
+
+## Staff
+- Q: I am the bocal, how to purge cache from a login?
+  - A: From bocal's network, make GET call at `http://<rpi-IP>/?purge=<login>`
+- Q: Something's f*cky, need to debug!
+  - A: Logs can be found in folder `logs/<date>-hallvoice.log`
+- Q: How to update?
+  - A: Hmmm, Are you pisciner? A simple `git pull` should do the trick :)
+
+# Fun fact
+- When redis cache is fully pre-filled:
+  - it consume ~300M of disk space
+  - 39888 TTS cached (2493 firstname * 16 welcome and goodbye message)
+  - ~5300 login is used to cache firstnames
+- Volume is at maximum in `alsamixer`
+
+# Change logs
+- Hallvoice V2
+  - Now works with kafka
+- Hallvoice V3
+  - Still in python but now code is object oriented
+  - Redis cache to store the firstname from 42API
+  - Redis cache to store
+  - Norm and sanitize JSON files
+- Hallvoice V3.1
+  - Dockerized!
+
+###### Made with love by 42Paris team SI
+
+###### Soon, Hallvoice V4 in Golang!

cache/README.md

@@ -1 +1,4 @@
-# cache
+# Cache
+You can bind this foler to your docker container
+
+Default location for redis cache is `/var/lib/redis/dump.rdb`

config.ini → config/config.ini.example

@@ -1,12 +1,21 @@
-[kafka_conf]
-kafka_servers = 127.0.0.1
-topic = <topic-name>
-group_id = <group-name>
-username = <user-name>
-password = <password>
+[kafka]
+kafka_servers = <redpanda>
+topic = <topic>
+group_id = <group_id>
+username = <user>
+password = <passwd>
+
+[redis]
+host = 127.0.0.1
+port = 6379
+ttl = 15778800  # 6 Months
+
+[42api]
+uid = <API42-UID-key>
+secret = <API42-Top-Secret-Do_no_push_me>
 
 [building]
-name = <Where am I?>
+name = <where>
 
 [welcome]
 message1 = Bonjour <name>

custom/30_1.json

@@ -1,10 +1,8 @@
 {
-  "welcome":
-  {
-    "mp3": "trentinou/in"
-  },
-  "goodbye":
-  {
-    "mp3": "trentinou/out"
-  }
+    "welcome": {
+        "mp3": "trentinou/in"
+    },
+    "goodbye": {
+        "mp3": "trentinou/out"
+    }
 }

custom/_Example.json

@@ -0,0 +1,25 @@
+{
+"_comment": "To make your custom mp3 files working, please use the following JSON template",
+"_comment":  "First, you have to explicitly have a welcome and goodbye key",
+	"welcome":
+	{
+		"_comment": "Choses between `mp3` OR `txt`",
+		"_comment": "When `mp3` is used, Only ONE path is required, it could be a folder, or a single mp3 file",
+		"mp3":"mylogin/in",
+		"_comment": "mp3 files, MUST be in `./mp3/<yourlogin>/in`"
+	},
+	"goodbye":
+	{
+		"_comment": "Again, choses between `mp3` or `txt`",
+		"_comment": "When, `txt` is used, it generate a TTS with google (python3-gTTS)",
+		"_comment": "You can make one like so",
+
+        "txt": "Aurevoir hallvoice!",
+		"_comment": "OR you can make a list, randominette will be use to choose a random txt",
+		"txt": ["Bonsoir hallvoice", "Adieu hallvoice", "Tchao le hallvoice"],
+		"_comment": "By, default TTS is in french, you can use another language with key `lang`",
+		"lang": "zh-CN",
+		"_comment": "List of available language here: https://gtts.readthedocs.io/en/latest/_modules/gtts/lang.html"
+	},
+	"_comment": "FOR THE LOVE OF GOD, please remove comments before pushing your json :)"
+}

custom/aalliot.json

@@ -1,10 +1,8 @@
 {
-	"welcome":
-	{
-		"mp3":"aalliot/"
-	},
-	"goodbye":
-	{
-		"mp3":"aalliot/"
-	}
-}
+    "welcome": {
+        "mp3": "aalliot/"
+    },
+    "goodbye": {
+        "mp3": "aalliot/"
+    }
+}

custom/aaltun.json

@@ -1,11 +1,8 @@
 {
-    "welcome":
-    {
-      "mp3": "aaltun/in"
+    "welcome": {
+        "mp3": "aaltun/in"
     },
-    "goodbye":
-    {
-      "mp3": "aaltun/out"
+    "goodbye": {
+        "mp3": "aaltun/out"
     }
-  }
-
+}

custom/aasli.json

@@ -1,10 +1,8 @@
 {
-  "welcome":
-  {
-    "mp3": "aasli/in/"
-  },
-  "goodbye":
-  {
-    "mp3": "aasli/out/"
-  }
-}
+    "welcome": {
+        "mp3": "aasli/in/"
+    },
+    "goodbye": {
+        "mp3": "aasli/out/"
+    }
+}

custom/aaverty.json

@@ -1,10 +1,8 @@
 {
-	"welcome":
-	{
-		"mp3":"aaverty/"
-	},
-	"goodbye":
-	{
-		"mp3":"aaverty/"
-	}
-}
+    "welcome": {
+        "mp3": "aaverty/"
+    },
+    "goodbye": {
+        "mp3": "aaverty/"
+    }
+}

custom/abasdere.json

@@ -1,10 +1,8 @@
 {
-	"welcome":
-	{
-		"mp3":"abasdere/in"
-	},
-	"goodbye":
-	{
-		"mp3":"abasdere/out"
-	}
-}
+    "welcome": {
+        "mp3": "abasdere/in"
+    },
+    "goodbye": {
+        "mp3": "abasdere/out"
+    }
+}

custom/abemorea.json

@@ -1,10 +1,8 @@
 {
-	"welcome":
-	{
-		"mp3": "abemorea/entree"
-	},
-	"goodbye":
-	{
-		"mp3": "abemorea/sortie"
-	}
-}
+    "welcome": {
+        "mp3": "abemorea/in"
+    },
+    "goodbye": {
+        "mp3": "abemorea/out"
+    }
+}

custom/ablanar.json

@@ -1,10 +1,8 @@
 {
-    "welcome":
-    {
-      "mp3": "ablanar/in"
+    "welcome": {
+        "mp3": "ablanar/in"
     },
-    "goodbye":
-    {
-      "mp3": "ablanar/out"
+    "goodbye": {
+        "mp3": "ablanar/out"
     }
-  }
+}

custom/ablevin.json

@@ -1,11 +1,8 @@
-
 {
-  "welcome":
-  {
-    "mp3": "ablevin/in"
-  },
-  "goodbye":
-  {
-    "mp3": "ablevin/out"
-  }
-}
+    "welcome": {
+        "mp3": "ablevin/in"
+    },
+    "goodbye": {
+        "mp3": "ablevin/out"
+    }
+}

custom/abonard.json

@@ -1,10 +1,8 @@
 {
-	"welcome":
-	{
-		"mp3":"abonard/entree/"
-	},
-	"goodbye":
-	{
-		"mp3":"abonard/sortie/"
-	}
-}
+    "welcome": {
+        "mp3": "abonard/in/"
+    },
+    "goodbye": {
+        "mp3": "abonard/out/"
+    }
+}

custom/abonneca.json

@@ -1,10 +1,8 @@
 {
-  "welcome":
-  {
-    "mp3": "abonneca/in"
-  },
-  "goodbye":
-  {
-    "mp3": "abonneca/out"
-  }
-}
+    "welcome": {
+        "mp3": "abonneca/in"
+    },
+    "goodbye": {
+        "mp3": "abonneca/out"
+    }
+}