Aller au contenu

User

UserService(bot)

Source code in etuutt_bot/services/user.py 
20
21
def __init__(self, bot: EtuUTTBot):
    self._bot = bot

get_member_roles(user)

Retourne les rôles qui devraient être attribués à l'utilisateur donné.

Parameters:

Name Type Description Default
user ApiUserSchema

Les données utilisateur, telles que retournées par l'API du site etu

 required

Returns:

Type Description
set[Role]

L'ensemble des rôles par défaut à donner à l'utilisateur donné.
set[Role]

C'est-à-dire :
set[Role]
  • Si c'est un étudiant :
  • le rôle étudiant
  • le(s) rôle(s) de la ou des branches de sa formation.
  • les rôles correspondant à ses UEs du semestre (s'il en a)
set[Role]
  • Si c'est un ancien étudiant : le rôle ancien étudiant
set[Role]
  • Si c'est un enseignant : le rôle enseignant
Source code in etuutt_bot/services/user.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def get_member_roles(self, user: ApiUserSchema) -> set[Role]:
    """Retourne les rôles qui devraient être attribués à l'utilisateur donné.

    Args:
        user: Les données utilisateur, telles que retournées par l'API du site etu

    Returns:
        L'ensemble des rôles par défaut à donner à l'utilisateur donné.
        C'est-à-dire :
        - Si c'est un étudiant :
            - le rôle `étudiant`
            - le(s) rôle(s) de la ou des branches de sa formation.
            - les rôles correspondant à ses UEs du semestre (s'il en a)
        - Si c'est un ancien étudiant : le rôle `ancien étudiant`
        - Si c'est un enseignant : le rôle `enseignant`
    """
    member_type = user.member_type
    special_ids = self._bot.settings.guild.special_roles
    guild = self._bot.watched_guild
    if member_type == MemberType.Student:
        branches = {r for r in guild.roles if r.name.upper() in user.branches}
        ues = {r for r in guild.roles if r.name.upper() in user.ues}
        return {guild.get_role(special_ids.student)} | branches | ues
    if member_type == MemberType.FormerStudent:
        return {guild.get_role(special_ids.former_student)}
    if member_type == MemberType.Teacher:
        return {guild.get_role(special_ids.teacher)}
    assert_never(member_type)

sync(member, user) async

Synchronise le membre du serveur avec les données de l'api du site etu.

Parameters:

Name Type Description Default
member Member

Le membre du serveur Discord à synchroniser

 required
user ApiUserSchema

Les données de l'API

 required
Source code in etuutt_bot/services/user.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
async def sync(self, member: discord.Member, user: ApiUserSchema):
    """Synchronise le membre du serveur avec les données de l'api du site etu.

    Args:
        member: Le membre du serveur Discord à synchroniser
        user: Les données de l'API
    """
    nickname = self.get_server_nickname(user)
    roles = self.get_member_roles(user)
    if nickname == member.nick and roles <= set(member.roles):
        # user already synced
        return

    upmost_role: Role = max(self._bot.watched_guild.get_member(self._bot.user.id).roles)
    reason_msg = f"Authentification etu de : {member.global_name}"
    if any(r >= upmost_role for r in member.roles):
        # if the bot try to deal with a role higher
        # than its own highest role, discord returns a 403.
        # Thus, those must be given without using the `edit` method.
        # Moreover, the bot cannot edit the nicknames of users with higher roles.
        roles -= set(member.roles[1:])
        await member.add_roles(*roles, reason=reason_msg)
        return
    roles |= set(member.roles)
    await member.edit(nick=nickname, roles=roles, reason=reason_msg)