Merge branch 'more-framework-functions' into 'v4.x'

[ADD] Evecharacter API functions

See merge request allianceauth/allianceauth!1588

allianceauth/framework/api/evecharacter.py

@@ -0,0 +1,57 @@
+"""
+Alliance Auth Evecharacter API
+"""
+
+from typing import Optional
+
+from django.contrib.auth.models import User
+
+from allianceauth.authentication.models import CharacterOwnership
+from allianceauth.eveonline.models import EveCharacter
+from allianceauth.framework.api.user import get_sentinel_user
+
+
+def get_main_character_from_evecharacter(
+    character: EveCharacter,
+) -> Optional[EveCharacter]:
+    """
+    Get the main character for a given EveCharacter or None when no main character is set
+
+    :param character:
+    :type character:
+    :return:
+    :rtype:
+    """
+
+    try:
+        userprofile = character.character_ownership.user.profile
+    except (
+        AttributeError,
+        EveCharacter.character_ownership.RelatedObjectDoesNotExist,
+        CharacterOwnership.user.RelatedObjectDoesNotExist,
+    ):
+        return None
+
+    return userprofile.main_character
+
+
+def get_user_from_evecharacter(character: EveCharacter) -> User:
+    """
+    Get the user for an EveCharacter or the sentinel user when no user is found
+
+    :param character:
+    :type character:
+    :return:
+    :rtype:
+    """
+
+    try:
+        userprofile = character.character_ownership.user.profile
+    except (
+        AttributeError,
+        EveCharacter.character_ownership.RelatedObjectDoesNotExist,
+        CharacterOwnership.user.RelatedObjectDoesNotExist,
+    ):
+        return get_sentinel_user()
+
+    return userprofile.user

allianceauth/framework/api/user.py

@@ -6,17 +6,33 @@ from typing import Optional
 
 from django.contrib.auth.models import User
 
+from allianceauth.authentication.models import CharacterOwnership
 from allianceauth.eveonline.models import EveCharacter
 
 
-def get_sentinel_user() -> User:
+def get_all_characters_from_user(user: User) -> list:
     """
-    Get the sentinel user or create one
+    Get all characters from a user or an empty list
+    when no characters are found for the user or the user is None
 
+    :param user:
+    :type user:
     :return:
+    :rtype:
     """
 
-    return User.objects.get_or_create(username="deleted")[0]
+    if user is None:
+        return []
+
+    try:
+        characters = [
+            char.character for char in CharacterOwnership.objects.filter(user=user)
+        ]
+    except AttributeError:
+        return []
+
+    return characters
+
 
 def get_main_character_from_user(user: User) -> Optional[EveCharacter]:
     """
@@ -62,3 +78,13 @@ def get_main_character_name_from_user(user: User) -> str:
         return str(user)
 
     return username
+
+
+def get_sentinel_user() -> User:
+    """
+    Get the sentinel user or create one
+
+    :return:
+    """
+
+    return User.objects.get_or_create(username="deleted")[0]