plenum-bot/readme.md

# Plenum-Bot

Das ist der Plenums-Bot des Chaos Computer Clubs Berlin. Seine Aufgabe ist es, die Plena im Club anzukündigen, die an jedem 2. und 4. Dienstag im Monat stattfinden. Außerdem soll er das Pad mit den Plenumsnotizen ins Wiki des CCCB übertragen und neue Pads anlegen.
Die Nachrichten und Ankündigungen werden über den internen Mailverteiler und über interne Matrix-Gruppen an die Mitglieder versendet.

## Funktionsweise

Die genaue Funktionsweise des Bots wird in diesem Blogeintrag näher beschrieben:
https://marekkrug.de/posts/plenum-bot/

### Ankündigungsskript
- Schauen, wann ein Plenum stattfindet
- Wenn eins in 3 Tagen stattfindet, nächstes Pad kopieren und per Mail schicken
  - Pad als .md herunterladen
  - Text dranhängen und per mail an intern@ verschicken
- Wenn 1 Tag vor dem Plenum immer noch kein TOP im Pad ist
  - Mail mit Absage verschicken
### Neues-Pad-Erstellen-Skript
- Schauen, wann Plenum stattfindet
- Wenn eins im nächsten Monat stattfindet, von dem noch kein Pad erstellt wurde, dann eins hinzufügen 
### Pad-ins-Wiki-und-versenden-Skript
- Skript wird manuell nach dem Plenum ausgelöst
- Plenumspad wird als .md heruntergeladen
- Text dranhängen und per Mail an intern@ verschicken
- Pad in MediaWiki-Format umwandeln
- Neue Wiki-Seite erstellen und dort das umgewandelte Pad hochladen


## Installation

Um den Bot z.B. auf einer neu erstellten VM zu installieren, kannst du dieser Anleitung für ubuntu-server folgen und diese Anweisungen ggf. für deine Distro anpassen:

1) Rust installieren ([rust-lang.org](https://www.rust-lang.org/tools/install))

2) Dieses Repo klonen:

```bash
git pull https://git.berlin.ccc.de/murmeldin/plenum-bot.git
```

3) Die Dependencies installieren und den Bot kompilieren:
```bash
cd plenum-bot
./util/install_script_ubuntu.sh
```

4) Config überprüfen und schauen, ob alles passt:
```bash
./util/change-config.sh
```

5) Den Bot aktivieren:
```bash
systemctl enable plenumsbot.timer
```

6) In den logs überprüfen, ob alles passt:
```bash
journalctl -u plenumsbot.service
```

---

## TO-DO LIST
### main.rs
- [ ] Add logic for top_anzahl in main.rs:172

### MediaWiki

- [X] Add "get_csrf_token-function" for getting a write token to allow write operations in the wiki (murmeldin)
- [X] Add "create_page" function for creating new pages in the wiki that is called on every day after plenum (murmeldin)
- [ ] Add "modify_plenum_main_page" function for creating new Links on the Plenum main page whenever the create_page function is being called (murmeldin)
- [ ] Date Logic for create_page-function (maybe nobody or murmeldin when date_logic branch is done and merged)

### future improvements:
- search ADJ_TIMEYWIMEY to find places that need adjusting if the bot might run late
  (that's an incomplete list, but tag things as you notice them…)