Module contributions : annonce des nouvelles contributions du Drive EPL by thremilien · Pull Request #147 · Hokkaydo/EPLBot

thremilien · 2026-09-28T15:57:57Z

Pourquoi

Les contributions déposées dans Contributions EPL-Drive/ passent facilement inaperçues et s'accumulent. Ce module annonce chaque nouveau fichier sur Discord pour qu'elles soient traitées au fil de l'eau.

Ce que fait le module `contributions`

Liste le dossier des contributions via rclone, toutes les heures (CONTRIBUTIONS_UPDATE_PERIOD, en minutes).
Annonce chaque nouveau fichier (chemin + taille) dans le salon existant DRIVE_ADMIN_CHANNEL_ID.
Mentionne le rôle CONTRIBUTIONS_ROLE_ID (optionnel), une seule fois par passage pour qu'un gros dépôt ne ping pas 30 fois.
/contributions (admins, réponse éphémère) liste les fichiers pas encore importés, c'est-à-dire encore présents dans le dossier.

Détails de fonctionnement :

Fichiers suivis par identifiant Drive : un fichier sorti du dossier lors d'un import ne déclenche rien, un fichier renommé n'est pas ré-annoncé.
Au premier passage (ou si le dossier surveillé change), un seul message récapitulatif « N fichier(s) déjà présent(s) » au lieu d'une annonce par fichier.
Si le salon n'est pas défini ou pas accessible, les fichiers restent en attente et sont annoncés dès que possible.
Les erreurs (token expiré, dossier introuvable…) sont envoyées une fois dans le salon admin, pas à chaque passage.
Les noms de fichiers ne peuvent mentionner personne (@everyone dans un nom de fichier est neutralisé).

Configuration

CONTRIBUTIONS_REMOTE (variable d'environnement) : dossier au format rclone, ex. onedrive:Fichiers de Maxime Drooghaag - Drive EPL/Contributions EPL-Drive. En variable d'env plutôt que /config, pour que les admins Discord ne puissent pas pointer vers un autre dossier du OneDrive lié.
rclone est ajouté à l'image Docker (rclone/rclone:1), sa config est lue dans persistence/rclone.conf (RCLONE_CONFIG).
Procédure complète dans le README : token en lecture seule (--onedrive-access-scopes "Files.Read Files.Read.All Sites.Read.All offline_access"), création du remote via le rclone de l'image, reconnexion si le token expire.

Nouvelles tables SQLite : contribution_files, contribution_remotes. Nouvelles clés /config : CONTRIBUTIONS_ROLE_ID, CONTRIBUTIONS_UPDATE_PERIOD.

⚠️ À discuter avant de merger

Accès OneDrive sur le serveur : le token rclone donne accès (en lecture seule si on suit le README) au OneDrive du compte UCLouvain qui l'a créé, et serait stocké dans data/rclone.conf sur le VPS. À valider ensemble : quel compte, et qui fait la mise en place.
Le PDF « Contributions Drive EPL - EPL Drive Contribution System.pdf » est en permanence dans le dossier : il est compté au premier message et apparaît dans /contributions. Faut-il l'exclure ?
/contributions est réservée aux membres ayant la permission Administrateur ; si les admins du Drive ne l'ont pas, on peut plutôt la limiter au salon DRIVE_ADMIN_CHANNEL_ID.

Tests

Compilé avec Java 25 (image build du Dockerfile). Testé de bout en bout sur un serveur Discord de test avec un dossier OneDrive de test :

Premier lancement : un seul message récapitulatif, sans mention
Nouveau fichier : annonce avec chemin, taille et mention du rôle
3 fichiers d'un coup : 3 messages, une seule mention ; @everyone dans un nom de fichier ne mentionne personne
Fichier sorti du dossier (import) : aucun message
/contributions : liste correcte, erreur explicite si le dossier est introuvable, message dédié si vide
Salon non défini : une seule erreur dans le salon admin, rattrapage des fichiers en attente une fois le salon défini
Mauvais CONTRIBUTIONS_REMOTE : une seule erreur sur 3 passages
Redémarrage : aucune ré-annonce
Non testé : token lecture seule du README, salon sans permission d'écriture pour le bot

Periodically lists the Drive contributions folder through rclone and announces each new file in DRIVE_ADMIN_CHANNEL_ID, optionally mentioning CONTRIBUTIONS_ROLE_ID once per batch. /contributions lists the files not imported yet. - Files are tracked by Drive id: files moved out on import trigger nothing - First listing of a remote only sends a summary message - Listing errors are reported once in the admin channel - rclone is added to the runtime image, its config lives in persistence/

Hokkaydo

A few comments, and maybe reconsider the use of a repository.

Regarding the general PR message, 2 points are mentioned but not resolved:

Le PDF « Contributions Drive EPL - EPL Drive Contribution System.pdf » est en permanence dans le dossier : il est compté au premier message et apparaît dans /contributions. Faut-il l'exclure ?

/contributions est réservée aux membres ayant la permission Administrateur ; si les admins du Drive ne l'ont pas, on peut plutôt la limiter au salon DRIVE_ADMIN_CHANNEL_ID.

For the first one, I'd say the file has to be excluded from analysis. For the permission, drive admins do not have the Administrator permission. Rather than limiting the command to admins, it can be allowed for people having the DRIVE_ADMIN_ROLE_ID (to be configured; it doesn't exist yet). Or, instead of allowing every channel for the command, filter by the DRIVE_ADMIN_CHANNEL_ID. The first suggestion is more convenient, but the second one is easier to implement

Hokkaydo · 2026-09-28T21:14:18Z

+        }
+        List<String> lines = new ArrayList<>();
+        lines.add(Strings.getString("contributions.command.header").formatted(files.size()));
+        files.stream().map(f -> "• %s (%s)".formatted(f.displayPath(), f.displaySize())).forEach(lines::add);


Use plain "-" instead of "•"

Hokkaydo · 2026-09-28T21:19:45Z

+    boolean isSeeded(long guildId, String remote);
+
+    /**
+     * Records that the existing files of this remote have been recorded for this guild


wtf does that line even mean

Gone with the repository removal (it recorded that a remote's existing files had been seen, to avoid announcing them all at first run).

Hokkaydo · 2026-09-28T21:20:10Z

+     * @param remote the rclone remote path
+     * @return true if the existing files of this remote have already been recorded for this guild
+     * */
+    boolean isSeeded(long guildId, String remote);


why "isSeeded" ? what does it mean

Removed along with the repository, see the reply on line 8.

Hokkaydo · 2026-09-28T21:45:51Z

+
+import java.util.Set;
+
+public interface ContributionFileRepository extends CRUDRepository<ContributionFile> {


I wonder if that whole repository is required at all. It seems to store unnecessary data. Maybe consider using the already existing system of Guild Variable through ConfigurationRepository#getGuildState and storing only the creation date of the last processed file instead of storing useless file IDs over and over

Agreed, removed. It now stores only CONTRIBUTIONS_LAST_UPLOAD in guild state, using OneDrive's upload time (utime, via rclone lsjson --metadata) rather than the modification time, which keeps the uploader's local date.

Hokkaydo · 2026-09-28T21:48:57Z

+    private static String truncate(String message) {
+        if (message == null) return "";
+        // Keep the end: rclone's last lines hold the actual reason of the failure
+        return message.length() > MAX_ERROR_LENGTH ? "…" + message.substring(message.length() - MAX_ERROR_LENGTH) : message;


Use 3 dots instead of the ellipsis, it might not render properly in some cases

Hokkaydo · 2026-09-28T21:54:15Z

+        try {
+            check();
+        } catch (InterruptedException e) {
+            Thread.currentThread().interrupt();


In that case abort the module's initialisation and warn about it, since its only caused by a missing env var

Done: the module no longer enables if CONTRIBUTIONS_REMOTE is missing, and warns in the logs and the admin channel.

Hokkaydo · 2026-09-28T21:55:54Z

    - `GITHUB_APPLICATION_ID`: Identifiant de l'application Github liée (permet de gérer les issues) *(Optionnel)*
    - `GITHUB_APPLICATION_INSTALLATION_ID`: Identifiant d'installation de l'application Github liée (permet de gérer les issues) *(Optionnel)*
    - `HASTEBIN_TOKEN`: Jeton d'identification auprès de l'API de Hastebin
+    - `CONTRIBUTIONS_REMOTE`: Dossier des contributions du Drive EPL au format rclone, ex. `onedrive:Fichiers de Maxime Drooghaag - Drive EPL/Contributions EPL-Drive` *(Optionnel, module `contributions`)*


Do not mention explicit names (remove the example or abstract the name)

Done, replaced with a placeholder.

…LE_ID, exclude contribution system PDF - Replace the contribution file repository and tables with a single CONTRIBUTIONS_LAST_UPLOAD guild state, based on OneDrive upload time (rclone --metadata utime) - Allow /contributions for members with the new DRIVE_ADMIN_ROLE_ID role (and administrators) - Exclude the permanent contribution system PDF from the listing - Do not enable the module and warn when CONTRIBUTIONS_REMOTE is not set - Use plain ASCII characters, remove explicit names from README

thremilien · 2026-09-28T22:27:07Z

Thanks for the review, all addressed in e85213b:

The contribution system PDF is excluded from the analysis.
/contributions is now available to members with the new DRIVE_ADMIN_ROLE_ID role (and administrators). It needs to be set with /config.

Hokkaydo requested changes Sep 28, 2026

View reviewed changes

Hokkaydo merged commit f645687 into Hokkaydo:dev Sep 29, 2026
3 checks passed


		import java.util.Set;

		public interface ContributionFileRepository extends CRUDRepository<ContributionFile> {

Conversation

thremilien commented Sep 28, 2026

Pourquoi

Ce que fait le module contributions

Configuration

⚠️ À discuter avant de merger

Tests

Uh oh!

Hokkaydo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thremilien commented Sep 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Ce que fait le module `contributions`