Add support for custom logos and icons in Apple Wallet passes

Author: RobotHanzo

indico_custom_pass/plugin.py

@@ -5,6 +5,7 @@
 
 from indico_custom_pass.settings import CustomPassSettingsForm
 
+
 class CustomPassPlugin(IndicoPlugin):
     """Custom Pass
 
@@ -16,7 +17,10 @@ class CustomPassPlugin(IndicoPlugin):
         'apple_pass_background_color': '#007cac',
         'apple_pass_foreground_color': '#ffffff',
         'apple_pass_label_color': '#ffffff',
-        'apple_pass_organization_name': 'Indico',
+        'apple_pass_logo_text': 'Indico',
+        'apple_pass_customize_logo': False,
+        'apple_pass_custom_icon_url': '',
+        'apple_pass_custom_logo_url': '',
         'google_pass_background_color': '#007cac'
     }
 
@@ -31,7 +35,21 @@ def build_pass_object(self, registration):
         p.backgroundColor = CustomPassPlugin.settings.get('apple_pass_background_color')
         p.foregroundColor = CustomPassPlugin.settings.get('apple_pass_foreground_color')
         p.labelColor = CustomPassPlugin.settings.get('apple_pass_label_color')
-        p.organizationName = CustomPassPlugin.settings.get('apple_pass_organization_name')
+        p.logoText = CustomPassPlugin.settings.get('apple_pass_logo_text')
+        if bool(CustomPassPlugin.settings.get('apple_pass_customize_logo')):
+            # Per apple docs:
+            # The dimensions given above are all in points. On a non-Retina display, each point equals exactly 1 pixel.
+            # On a Retina display, there are 2 or 3 pixels per point, depending on the device.
+            # To support all screen sizes and resolutions, provide the original, @2x, and @3x versions of your art.
+            # TODO
+            # This is a easy way to fool apple to render the logo at higher resolutions, however the user shall have the
+            # choice to provide logos for different aspect ratios, to allow for more efficient ticket sizes
+            p.add_file_from_url('icon.png', CustomPassPlugin.settings.get('apple_pass_custom_icon_url'))
+            p.add_file_from_url('icon@2x.png', CustomPassPlugin.settings.get('apple_pass_custom_icon_url'))
+            p.add_file_from_url('icon@3x.png', CustomPassPlugin.settings.get('apple_pass_custom_icon_url'))
+            p.add_file_from_url('logo.png', CustomPassPlugin.settings.get('apple_pass_custom_logo_url'))
+            p.add_file_from_url('logo@2x.png', CustomPassPlugin.settings.get('apple_pass_custom_logo_url'))
+            p.add_file_from_url('logo@3x.png', CustomPassPlugin.settings.get('apple_pass_custom_logo_url'))
         return p
 
 

indico_custom_pass/settings.py

@@ -1,5 +1,5 @@
 from indico.web.forms.base import IndicoForm
-from wtforms import StringField, ColorField
+from wtforms import StringField, ColorField, BooleanField
 from wtforms.validators import Regexp
 
 from indico_custom_pass import _
@@ -9,33 +9,51 @@ class CustomPassSettingsForm(IndicoForm):
     apple_pass_background_color = ColorField(
         _('Apple Wallet pass background color'),
         description=_(
-            'The background color of the Apple Wallet pass in HEX format (e.g. #000000 for black, #ffffff for white).'),
+            'The background color of the Apple Wallet pass.'),
         validators=[Regexp(r'^#(?:[0-9a-fA-F]{3}){1,2}$', message=_('Invalid HEX color format.'))],
         default='#000000'
     )
     apple_pass_foreground_color = ColorField(
         _('Apple Wallet pass foreground color'),
         description=_(
-            'The foreground color of the Apple Wallet pass in HEX format (e.g. #000000 for black, #ffffff for white).'),
+            'The foreground color of the Apple Wallet pass.'),
         validators=[Regexp(r'^#(?:[0-9a-fA-F]{3}){1,2}$', message=_('Invalid HEX color format.'))],
         default='#ffffff'
     )
     apple_pass_label_color = ColorField(
         _('Apple Wallet pass label color'),
         description=_(
-            'The label color of the Apple Wallet pass in HEX format (e.g. #000000 for black, #ffffff for white).'),
+            'The label color of the Apple Wallet pass.'),
         validators=[Regexp(r'^#(?:[0-9a-fA-F]{3}){1,2}$', message=_('Invalid HEX color format.'))],
         default='#ffffff'
     )
-    apple_pass_organization_name = StringField(
-        _('Apple Wallet pass organization name'),
-        description=_('The organization name displayed on the Apple Wallet pass.'),
+    apple_pass_logo_text = StringField(
+        _('Apple Wallet pass logo text'),
+        description=_('The string displayed next to your logo on the Apple Wallet pass.'),
         default='Indico',
     )
+    apple_pass_customize_logo = BooleanField(
+        _('Customize Apple Wallet pass logo'),
+        description=_(
+            'If enabled, the logo on the Apple Wallet pass will be replaced with the image you specify below; WALLET_LOGO_URL from the official indico configuration will be ignored.'),
+        default=False,
+    )
+    apple_pass_custom_logo_url = StringField(
+        _('Apple Wallet pass custom logo URL'),
+        description=_(
+            'The URL of the custom logo to be used on the Apple Wallet pass. Must be a PNG image.\nPer apple docs: The logo image (logo.png) is displayed in the top left corner of the pass, next to the logo text. The allotted space is 160 x 50 points; in most cases it should be narrower.'),
+        default='',
+    )
+    apple_pass_custom_icon_url = StringField(
+        _('Apple Wallet pass custom icon URL'),
+        description=_(
+            'The URL of the custom icon to be used on the Apple Wallet pass. Must be a PNG image.\nPer apple docs: The icon (icon.png) is displayed when a pass is shown on the lock screen and by apps such as Mail when showing a pass attached to an email. The icon should measure 29 x 29 points.'),
+        default='',
+    )
     google_pass_background_color = ColorField(
         _('Google Wallet pass background color'),
         description=_(
-            'The background color of the Google Wallet pass in HEX format (e.g. #000000 for black, #ffffff for white).'),
+            'The background color of the Google Wallet pass.'),
         validators=[Regexp(r'^#(?:[0-9a-fA-F]{3}){1,2}$', message=_('Invalid HEX color format.'))],
         default='#007cac'
     )

pyproject.toml

@@ -2,7 +2,7 @@
 name = 'indico-custom-pass'
 description = 'Grants admins the ability to customize Indico Google Wallet & Apple Pay passes.'
 readme = 'README.md'
-version = '1.0.3'
+version = '1.0.4'
 license = {text = "MIT License"}
 authors = [{ name = 'RobotHanzo', email = 'admin@robothanzo.dev' }]
 classifiers = [