Add support for type icons to evelinks

allianceauth/eveonline/evelinks/__init__.py

@@ -4,14 +4,14 @@
 # It contains of modules for views and templatetags for templates
 
 # list of all eve entity categories as defined in ESI
-ESI_CATEGORY_AGENT = "agent"
-ESI_CATEGORY_ALLIANCE = "alliance"
-ESI_CATEGORY_CHARACTER = "character"
-ESI_CATEGORY_CONSTELLATION = "constellation"
-ESI_CATEGORY_CORPORATION = "corporation"
-ESI_CATEGORY_FACTION = "faction"
-ESI_CATEGORY_INVENTORYTYPE = "inventory_type"
-ESI_CATEGORY_REGION = "region"
-ESI_CATEGORY_SOLARSYSTEM = "solar_system"
-ESI_CATEGORY_STATION = "station"
-ESI_CATEGORY_WORMHOLE = "wormhole"
+_ESI_CATEGORY_AGENT = "agent"
+_ESI_CATEGORY_ALLIANCE = "alliance"
+_ESI_CATEGORY_CHARACTER = "character"
+_ESI_CATEGORY_CONSTELLATION = "constellation"
+_ESI_CATEGORY_CORPORATION = "corporation"
+_ESI_CATEGORY_FACTION = "faction"
+_ESI_CATEGORY_INVENTORYTYPE = "inventory_type"
+_ESI_CATEGORY_REGION = "region"
+_ESI_CATEGORY_SOLARSYSTEM = "solar_system"
+_ESI_CATEGORY_STATION = "station"
+_ESI_CATEGORY_WORMHOLE = "wormhole"

allianceauth/eveonline/evelinks/dotlan.py

@@ -2,24 +2,30 @@
 
 from urllib.parse import urljoin, quote
 
-from . import *
+from . import (
+    _ESI_CATEGORY_ALLIANCE, 
+    _ESI_CATEGORY_CORPORATION, 
+    _ESI_CATEGORY_REGION, 
+    _ESI_CATEGORY_SOLARSYSTEM
+)
 
-BASE_URL = 'http://evemaps.dotlan.net'
+
+_BASE_URL = 'http://evemaps.dotlan.net'
 
 
 def _build_url(category: str, name: str) -> str:
     """return url to profile page for an eve entity"""
     
-    if category == ESI_CATEGORY_ALLIANCE:        
+    if category == _ESI_CATEGORY_ALLIANCE:        
         partial = 'alliance'
 
-    elif category == ESI_CATEGORY_CORPORATION:        
+    elif category == _ESI_CATEGORY_CORPORATION:        
         partial = 'corp'
 
-    elif category == ESI_CATEGORY_REGION:
+    elif category == _ESI_CATEGORY_REGION:
         partial = 'map'
     
-    elif category == ESI_CATEGORY_SOLARSYSTEM:
+    elif category == _ESI_CATEGORY_SOLARSYSTEM:
         partial = 'system'
     
     else:
@@ -28,7 +34,7 @@ def _build_url(category: str, name: str) -> str:
         )
         
     url = urljoin(
-        BASE_URL,
+        _BASE_URL,
         '{}/{}'.format(partial, quote(str(name).replace(" ", "_")))
         
     )
@@ -37,16 +43,19 @@ def _build_url(category: str, name: str) -> str:
 
 def alliance_url(name: str) -> str:
     """url for page about given alliance on dotlan"""
-    return _build_url(ESI_CATEGORY_ALLIANCE, name)
+    return _build_url(_ESI_CATEGORY_ALLIANCE, name)
+
 
 def corporation_url(name: str) -> str:
     """url for page about given corporation on dotlan"""
-    return _build_url(ESI_CATEGORY_CORPORATION, name)
+    return _build_url(_ESI_CATEGORY_CORPORATION, name)
+
 
 def region_url(name: str) -> str:
     """url for page about given region on dotlan"""
-    return _build_url(ESI_CATEGORY_REGION, name)
+    return _build_url(_ESI_CATEGORY_REGION, name)
+
 
 def solar_system_url(name: str) -> str:
     """url for page about given solar system on dotlan"""
-    return _build_url(ESI_CATEGORY_SOLARSYSTEM, name)
+    return _build_url(_ESI_CATEGORY_SOLARSYSTEM, name)

allianceauth/eveonline/evelinks/eveimageserver.py

@@ -0,0 +1,129 @@
+from . import (
+    _ESI_CATEGORY_ALLIANCE, 
+    _ESI_CATEGORY_CHARACTER, 
+    _ESI_CATEGORY_CORPORATION, 
+    _ESI_CATEGORY_INVENTORYTYPE
+)
+
+
+_EVE_IMAGE_SERVER_URL = 'https://images.evetech.net'
+_DEFAULT_IMAGE_SIZE = 32
+
+
+def _eve_entity_image_url(    
+    category: str,
+    entity_id: int,
+    size: int = 32,
+    variant: str = None,
+    tenant: str = None,
+) -> str:
+    """returns image URL for an Eve Online ID.
+    Supported categories: alliance, corporation, character, inventory_type
+    
+    Arguments:
+    - category: category of the ID, see ESI category constants
+    - entity_id: Eve ID of the entity
+    - size: (optional) render size of the image.must be between 32 (default) and 1024
+    - variant: (optional) image variant for category. currently not relevant.
+    - tenant: (optional) Eve Server, either `tranquility`(default) or `singularity`
+
+    Returns:
+    - URL string for the requested image on the Eve image server
+
+    Exceptions:
+    - Throws ValueError on invalid input
+    """
+    
+    # input validations
+    categories = {
+        _ESI_CATEGORY_ALLIANCE: {
+            'endpoint': 'alliances',
+            'variants': ['logo']
+        },
+        _ESI_CATEGORY_CORPORATION: {
+            'endpoint': 'corporations',
+            'variants': ['logo']
+        },
+        _ESI_CATEGORY_CHARACTER: {
+            'endpoint': 'characters',
+            'variants': ['portrait']
+        },
+        _ESI_CATEGORY_INVENTORYTYPE: {
+            'endpoint': 'types',
+            'variants': ['icon', 'render']
+        }
+    }
+    tenants = ['tranquility', 'singularity']
+   
+    if not entity_id:
+        raise ValueError('Invalid entity_id: {}'.format(entity_id))
+    else:
+        entity_id = int(entity_id)
+    
+    if not size or size < 32 or size > 1024 or (size & (size - 1) != 0):
+        raise ValueError('Invalid size: {}'.format(size))
+   
+    if category not in categories:
+        raise ValueError('Invalid category {}'.format(category))
+    else:
+        endpoint = categories[category]['endpoint']
+
+    if variant:
+        if variant not in categories[category]['variants']:
+            raise ValueError('Invalid variant {} for category {}'.format(
+                variant,
+                category
+            ))
+    else:
+        variant = categories[category]['variants'][0]
+
+    if tenant and tenant not in tenants:
+        raise ValueError('Invalid tenant {}'.format(tenant))
+        
+    # compose result URL
+    result = '{}/{}/{}/{}?size={}'.format(
+        _EVE_IMAGE_SERVER_URL,
+        endpoint,
+        entity_id,
+        variant,
+        size
+    )
+    if tenant:
+        result += '&tenant={}'.format(tenant)
+    
+    return result
+
+
+def alliance_logo_url(alliance_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
+    """image URL for the given alliance ID"""
+    return _eve_entity_image_url(_ESI_CATEGORY_ALLIANCE, alliance_id, size)
+
+
+def corporation_logo_url(
+    corporation_id: int, size: int = _DEFAULT_IMAGE_SIZE
+) -> str:
+    """image URL for the given corporation ID"""
+    return _eve_entity_image_url(
+        _ESI_CATEGORY_CORPORATION, corporation_id, size
+    )
+
+
+def character_portrait_url(
+    character_id: int, size: int = _DEFAULT_IMAGE_SIZE
+) -> str:
+    """image URL for the given character ID"""
+    return _eve_entity_image_url(_ESI_CATEGORY_CHARACTER, character_id, size)
+
+
+def type_icon_url(type_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
+    """icon image URL for the given type ID"""
+    return _eve_entity_image_url(
+        _ESI_CATEGORY_INVENTORYTYPE, type_id, size, variant='icon'
+    )
+
+
+def type_render_url(type_id: int, size: int = _DEFAULT_IMAGE_SIZE) -> str:
+    """render image URL for the given type ID"""
+    return _eve_entity_image_url(
+        _ESI_CATEGORY_INVENTORYTYPE, type_id, size, variant='render'
+    )

allianceauth/eveonline/evelinks/evewho.py

@@ -1,22 +1,27 @@
 # this module generates profile URLs for evewho
 
-from urllib.parse import urljoin, quote
+from urllib.parse import urljoin
 
-from . import *
+from . import (
+    _ESI_CATEGORY_ALLIANCE, 
+    _ESI_CATEGORY_CORPORATION, 
+    _ESI_CATEGORY_CHARACTER,  
+)
 
-BASE_URL = 'https://evewho.com'
+
+_BASE_URL = 'https://evewho.com'
 
 
 def _build_url(category: str, eve_id: int) -> str:
     """return url to profile page for an eve entity"""
     
-    if category == ESI_CATEGORY_ALLIANCE:        
+    if category == _ESI_CATEGORY_ALLIANCE:        
         partial = 'alliance'
 
-    elif category == ESI_CATEGORY_CORPORATION:        
+    elif category == _ESI_CATEGORY_CORPORATION:        
         partial = 'corporation'
 
-    elif category == ESI_CATEGORY_CHARACTER:
+    elif category == _ESI_CATEGORY_CHARACTER:
         partial = 'character'
     
     else:
@@ -25,7 +30,7 @@ def _build_url(category: str, eve_id: int) -> str:
         )
     
     url = urljoin(
-        BASE_URL,
+        _BASE_URL,
         '{}/{}'.format(partial, int(eve_id))
     )
     return url
@@ -33,12 +38,14 @@ def _build_url(category: str, eve_id: int) -> str:
 
 def alliance_url(eve_id: int) -> str:
     """url for page about given alliance on evewho"""
-    return _build_url(ESI_CATEGORY_ALLIANCE, eve_id)
+    return _build_url(_ESI_CATEGORY_ALLIANCE, eve_id)
+
 
 def character_url(eve_id: int) -> str:
     """url for page about given character on evewho"""
-    return _build_url(ESI_CATEGORY_CHARACTER, eve_id)
+    return _build_url(_ESI_CATEGORY_CHARACTER, eve_id)
+
 
 def corporation_url(eve_id: int) -> str:
     """url for page about given corporation on evewho"""
-    return _build_url(ESI_CATEGORY_CORPORATION, eve_id)
+    return _build_url(_ESI_CATEGORY_CORPORATION, eve_id)

allianceauth/eveonline/evelinks/tests/test_evelinks.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 
 from ...models import EveCharacter, EveCorporationInfo, EveAllianceInfo
-from .. import dotlan, zkillboard, evewho
+from .. import dotlan, zkillboard, evewho, eveimageserver
 from ...templatetags import evelinks
 
 
@@ -90,3 +90,115 @@ class TestZkillboard(TestCase):
             'https://zkillboard.com/system/12345678/'
         )
 
+
+class TestEveImageServer(TestCase):
+    """unit test for eveimageserver"""
+    
+    def test_sizes(self):        
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42),  
+            'https://images.evetech.net/characters/42/portrait?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=32),  
+            'https://images.evetech.net/characters/42/portrait?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=64),  
+            'https://images.evetech.net/characters/42/portrait?size=64'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=128),  
+            'https://images.evetech.net/characters/42/portrait?size=128'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=256),  
+            'https://images.evetech.net/characters/42/portrait?size=256'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=512),  
+            'https://images.evetech.net/characters/42/portrait?size=512'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, size=1024),  
+            'https://images.evetech.net/characters/42/portrait?size=1024'
+        )
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=-5)
+
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=0)
+        
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=31)
+        
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=1025)
+
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('corporation', 42, size=2048)
+
+
+    def test_variant(self):
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, variant='portrait'),  
+            'https://images.evetech.net/characters/42/portrait?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('alliance', 42, variant='logo'),  
+            'https://images.evetech.net/alliances/42/logo?size=32'
+        )
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('character', 42, variant='logo')
+    
+
+    def test_alliance(self):
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('alliance', 42),  
+            'https://images.evetech.net/alliances/42/logo?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('corporation', 42),  
+            'https://images.evetech.net/corporations/42/logo?size=32'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42),  
+            'https://images.evetech.net/characters/42/portrait?size=32'
+        )
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('station', 42)
+
+
+    def test_tenants(self):
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, tenant='tranquility'),  
+            'https://images.evetech.net/characters/42/portrait?size=32&tenant=tranquility'
+        )
+        self.assertEqual(
+            eveimageserver._eve_entity_image_url('character', 42, tenant='singularity'),  
+            'https://images.evetech.net/characters/42/portrait?size=32&tenant=singularity'
+        )
+        with self.assertRaises(ValueError):
+            eveimageserver._eve_entity_image_url('character', 42, tenant='xxx')
+        
+    def test_alliance_logo_url(self):
+        expected = 'https://images.evetech.net/alliances/42/logo?size=128'
+        self.assertEqual(eveimageserver.alliance_logo_url(42, 128), expected)
+
+    def test_corporation_logo_url(self):
+        expected = 'https://images.evetech.net/corporations/42/logo?size=128'
+        self.assertEqual(eveimageserver.corporation_logo_url(42, 128), expected)
+
+    def test_character_portrait_url(self):
+        expected = 'https://images.evetech.net/characters/42/portrait?size=128'
+        self.assertEqual(
+            eveimageserver.character_portrait_url(42, 128), expected
+        )
+
+    def test_type_icon_url(self):
+        expected = 'https://images.evetech.net/types/42/icon?size=128'
+        self.assertEqual(eveimageserver.type_icon_url(42, 128), expected)
+
+    def test_type_render_url(self):
+        expected = 'https://images.evetech.net/types/42/render?size=128'
+        self.assertEqual(eveimageserver.type_render_url(42, 128), expected)

allianceauth/eveonline/evelinks/tests/test_templatetags.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 
 from ...models import EveCharacter, EveCorporationInfo, EveAllianceInfo
-from .. import dotlan, zkillboard, evewho
+from .. import eveimageserver, evewho, dotlan, zkillboard
 from ...templatetags import evelinks
 
 
@@ -332,3 +332,28 @@ class TestTemplateTags(TestCase):
             ''
         )
 
+    def test_type_icon_url(self):
+        expected = eveimageserver.type_icon_url(123)
+        self.assertEqual(evelinks.type_icon_url(123), expected)
+
+        expected = eveimageserver.type_icon_url(123, 128)
+        self.assertEqual(evelinks.type_icon_url(123, 128), expected)
+        
+        expected = ''
+        self.assertEqual(evelinks.type_icon_url(123, 99), expected)
+        
+        expected = ''
+        self.assertEqual(evelinks.type_icon_url(None), expected)
+
+    def test_type_render_url(self):
+        expected = eveimageserver.type_render_url(123)
+        self.assertEqual(evelinks.type_render_url(123), expected)
+
+        expected = eveimageserver.type_render_url(123, 128)
+        self.assertEqual(evelinks.type_render_url(123, 128), expected)
+        
+        expected = ''
+        self.assertEqual(evelinks.type_render_url(123, 99), expected)
+        
+        expected = ''
+        self.assertEqual(evelinks.type_render_url(None), expected)

allianceauth/eveonline/evelinks/zkillboard.py

@@ -1,28 +1,35 @@
 # this module generates profile URLs for zKillboard
 
-from urllib.parse import urljoin, quote
+from urllib.parse import urljoin
 
-from . import *
+from . import (
+    _ESI_CATEGORY_ALLIANCE, 
+    _ESI_CATEGORY_CORPORATION, 
+    _ESI_CATEGORY_CHARACTER,
+    _ESI_CATEGORY_REGION, 
+    _ESI_CATEGORY_SOLARSYSTEM
+)
 
-BASE_URL = 'https://zkillboard.com'
+
+_BASE_URL = 'https://zkillboard.com'
 
 
 def _build_url(category: str, eve_id: int) -> str:
     """return url to profile page for an eve entity"""
     
-    if category == ESI_CATEGORY_ALLIANCE:        
+    if category == _ESI_CATEGORY_ALLIANCE:        
         partial = 'alliance'
 
-    elif category == ESI_CATEGORY_CORPORATION:        
+    elif category == _ESI_CATEGORY_CORPORATION:        
         partial = 'corporation'
 
-    elif category == ESI_CATEGORY_CHARACTER:
+    elif category == _ESI_CATEGORY_CHARACTER:
         partial = 'character'
 
-    elif category == ESI_CATEGORY_REGION:
+    elif category == _ESI_CATEGORY_REGION:
         partial = 'region'
 
-    elif category == ESI_CATEGORY_SOLARSYSTEM:
+    elif category == _ESI_CATEGORY_SOLARSYSTEM:
         partial = 'system'
     
     else:
@@ -31,7 +38,7 @@ def _build_url(category: str, eve_id: int) -> str:
         )
     
     url = urljoin(
-        BASE_URL,
+        _BASE_URL,
         '{}/{}/'.format(partial, int(eve_id))
     )
     return url
@@ -39,19 +46,23 @@ def _build_url(category: str, eve_id: int) -> str:
 
 def alliance_url(eve_id: int) -> str:
     """url for page about given alliance on zKillboard"""
-    return _build_url(ESI_CATEGORY_ALLIANCE, eve_id)
+    return _build_url(_ESI_CATEGORY_ALLIANCE, eve_id)
+
 
 def character_url(eve_id: int) -> str:
     """url for page about given character on zKillboard"""
-    return _build_url(ESI_CATEGORY_CHARACTER, eve_id)
+    return _build_url(_ESI_CATEGORY_CHARACTER, eve_id)
+
 
 def corporation_url(eve_id: int) -> str:
     """url for page about given corporation on zKillboard"""
-    return _build_url(ESI_CATEGORY_CORPORATION, eve_id)
+    return _build_url(_ESI_CATEGORY_CORPORATION, eve_id)
+
 
 def region_url(eve_id: int) -> str:
     """url for page about given region on zKillboard"""
-    return _build_url(ESI_CATEGORY_REGION, eve_id)
+    return _build_url(_ESI_CATEGORY_REGION, eve_id)
+
 
 def solar_system_url(eve_id: int) -> str:
-    return _build_url(ESI_CATEGORY_SOLARSYSTEM, eve_id)
+    return _build_url(_ESI_CATEGORY_SOLARSYSTEM, eve_id)