ZOOM-links

Aplikacja ZOOM-links, której zadaniem jest gromadzenie linków do spotkań w serwisie telekomunikacyjnym ZOOM ze wskazanej skrzynki mailowej.

Spis treści

• ZOOM-links
  • Spis treści
  • Autor
  • Funkcjonalności
  • Uruchomienie
    • Przygotowanie i uruchomienie
    • Wykorzystanie
    • Dodatkowe funkcjonalności
  • Uwaga
  • Wyjątki / Częste błędy
  • Dokumentacja
  • Specyfikacja
  • Do dalszego rozwoju:
  • Licencja

Autor

Górka Mateusz | goorkmateusz.github.io

Funkcjonalności

• Gromadzenie zaproszeń na spotkania na ZOOM'ie ze skrzynki mailowej;
• Wysyłanie zaproszeń na wskazane kanały Discorda;
• Usuwanie lub przenoszenie do folderu zaproszeń na spotkania na ZOOM ze skrzynki mailowej;

Uruchomienie

Przygotowanie i uruchomienie

1. Odpowiednio ustawić stałe w pliku konfiguracyjnym config.php.

Koniecznymi do skonfigurowania są:

	- Adres serwera skrzynki mailowej;
	- Twój adres e-mail;
	- Twoje hasło do skrzynki;
	- Maska adresata wiadomości
	- Domena adresów zoom

Wszystkie opisy znajdziesz w komentarzach pliku config.php.

1. Umieścić aplikację na komputerze obsługującym wykonywanie skrytów PHP.
2. Zadbać o odpowiednie ustawienie uprawnień plików i folderów, można posiłkować się skryptem: admin/init.sh.
3. Dodać wykonywanie skryptu check-mailbox.php do wywołania w cyklicznego w CRON.

Poprzez dodanie rekordu w crontab -e, które powoduje, że skrypt będzie wykonywane co 30min:

*/30 * * * * /<ścieżka/do/pliku>/admin/update.sh

Warto wykorzystać skrypt admin/update.sh:

cd `dirname "$0"`
cd ..

php check-mailbox.php > last_update.html

Aby ułatwić zadanie oraz mieć podgląd na wynik ostatniego wywołania.

Wykorzystanie

Podgląd listy zgromadzonych zaproszeń dostępny jest na stronie generowanej przez index.php.

Dodatkowe funkcjonalności

1. Konfiguracja automatycznego wysyłania zaproszeń na kanały Discorda. Zobacz: Jak skonfigurować Discorda.

Uwaga

• Skrypt zależnie od konfiguracji config.php może usuwać permanentnie przetworzone wiadomości ze skrzynki!

Wyjątki / Częste błędy

• Brak dostępu do odczytu lub zapisu pliku data/invitation-list.json lub data/invitation-list-write.json;
• Błąd połączenia ze skrzynką mailową;

Dokumentacja

Pliki PHP, JS, Python zawierają dokumentację według standardu programu Doxygen. Dokumentację można wygenerować poprzez polecenie doxygen dox/Doxyfile , wykorzystując plik konfiguracyjne Doxyfile.

Specyfikacja

• Język: PHP, JS, CSS, HTML;
• Preferowany system Linux (obsługa skryptów bash i modyfikacja praw dostępu przez chmod);

Do dalszego rozwoju:

• Wysyłanie wiadomości na Discordzie

• Wyświetla dzień tygodnia

• Wyświetla datę wygenerowania check-mailbox.php

• Usuwanie minionych spotkań z plików .json

• Przenoszenie maili do kosza, zamiast usuwania

• Usuwanie wiadomości zdublowanych (akcja dla zdublowanych)

• Tekstowe dodawanie zaproszeń. (inna treść, okno tekstowe copy-paste)

• Rozbudować interface w index.php

• Gromadzenie recent-from - przesłane od, aby analizować z której skrzynki przesłano wiadomości

• Przycisk "wyślij ponownie" w index.php

  • skrypt, który dostaje po GET link do zaproszenia i znajduje zaproszenie i wysyła na discorda

Całość listy ToDo do wygenerowania z komentarzy kodu.

Licencja

Zobacz w pliku LICENSE.md.