modules/WSOnboarding.py

   1 # Mattermost Bot module.
   2 #  Copyright (c) 2016-2022 by Someone <someone@somenet.org> (aka. Jan Vales <jan@jvales.net>)
   3 #  published under MIT-License
   4
   5 from inspect import cleandoc
   6
   7
   8 # pylint: disable=wrong-import-position
   9 from AbstractWSHandler import AbstractWSHandler
  10 class WSOnboarding(AbstractWSHandler):
  11     NAME = "onboarding"
  12
  13
  14     def __init__(self, user_teams_and_channels, guest_teams_and_channels):
  15         super().__init__()
  16
  17         self.user_teams_and_channels = user_teams_and_channels
  18         self.guest_teams_and_channels = guest_teams_and_channels
  19
  20
  21     def on_WS_EVENT(self, data):
  22         user = self.bot.api.get_user(data['data']['user_id'])
  23
  24         if not "system_guest" in user["roles"]:
  25             for team_id, chan_ids in self.user_teams_and_channels.items():
  26                 for chan_id in chan_ids:
  27                     self.bot.api.add_user_to_team(team_id, user["id"], exc=False)
  28                     self.bot.api.add_user_to_channel(chan_id, user["id"], exc=False)
  29         else:
  30             for team_id, chan_ids in self.guest_teams_and_channels.items():
  31                 for chan_id in chan_ids:
  32                     self.bot.api.add_user_to_team(team_id, user["id"], exc=False)
  33                     self.bot.api.add_user_to_channel(chan_id, user["id"], exc=False)
  34
  35         chan = self.bot.api.create_dm_channel_with(data['data']['user_id'])
  36
  37         self.bot.api.create_post(chan['id'], cleandoc("""
  38             ## **``Willkommen auf Mattermost!``**
  39
  40             Ich habe mir erlaubt, dich in beide Teams (Gruppen) zu joinen. Mit der linken Spalte kannst du zwischen den 2 Teams hin und her springen.
  41             **Das VoWi-Team beinhaltet**
  42             + Einen öffentlichen Channel für jede LVA der :tu: Inf-Studien. Diese Channels werden von mir gemanaged. Ich informiere auch, wenn sich im VoWi zu der jeweiligen LVA etwas tut. :)
  43             + Viele private Channels, die von Übungsgruppen genutzt werden. Du kannst für deine Gruppen gerne ebenfalls private Chanmel anlegen.
  44             **Das FSInf-Team beinhaltet**
  45             + Channels wie den Beratungschannel, Lernraum-Infos, das MemeOperationCenter, Programming und die Linux Lounge, Gaming, catcontent und andere Channels, die dich möglicherweise interessieren dürften.:)
  46             """))
  47
  48         self.bot.api.create_post(chan['id'], cleandoc("""
  49             Es gibt etliche Befehle, die dir die Navigation in Mattermost erleichtern sollen. Einige wichtige sind:
  50             + **``/join-all`` im FSInf-Team** - Befiehlt mir, dich in alle aktiven/verfügbaren öffentlichen Channels zu adden, damit du nich jedem Channel manuell beitreten musst.
  51             + **``/tissjoin <kopie der deutschsprachigen favoriten-tabelle aus tiss>`` nur im VoWi-Team** - Basically /join-all in sinnvoll. Added dich in die LVA-Channels deiner tiss-favoriten.
  52             + **``/beratungsinfo``** - Hilft dir, den Beratungschannel zu finden.
  53             + **``/threads``** - Mattermost benutzt Threads, um Diskussionen übersichtlicher zu gestalten. Mit diesem Befehl kannst du deine Mitstudierenden darauf hinweisen, Threads zu benutzen. Dies ist der wohl most over-used Befehl hier und ist bereits zu memes verarbeitet worden.
  54             + **``/raumsuche <Name des Raums>``** hilft dir Räume an der TU zu finden.
  55             """))
  56
  57         self.bot.api.create_post(chan['id'], cleandoc("""
  58             Das Motto auf mattermost ist: **``Be excellent to each other``**
  59             Sollte dir auffallen, dass sich wer nicht exzellent benimmt und z.b. andere beleidigt zögere nicht und kontaktiere eine_n der Team-Admin_as.
  60             Sollte ich mich mal nicht exzellent benehmen, z.b. indem ich Befehle nicht ordnungsgemäß ausführe, oder du mich verbessern willst (ich bin in python geschrieben), kontaktiere meinen Botmaster @someone.
  61
  62             Happy am meisten mattern :)
  63             """))
  64
  65         # additional info for guests.
  66         if "system_guest" in user["roles"]:
  67             self.bot.api.create_post(chan['id'], cleandoc("""
  68                 ## ``Confirm your student email to get full access to Mattermost``
  69                 Your account is currently a [guest account](https://docs.mattermost.com/deployment/guest-accounts.html), which means your user expirience is limited due to privacy, copyright and licencing reasons and you are restricted to these channels:
  70                 * Chat
  71                 * Beratung (Consultation)
  72                 * Guest-Talk
  73
  74                 Guest accounts are deleted after 30 days of inactivity.
  75
  76                 To gain full access to all channels and features you need to go to your Account Settings and change your email to ``eXXXXXXXX@student.tuwien.ac.at`` and then click on the link in the confirmation email. You will then get full access within an hour.
  77                 """))