lots of theming related changes

- upload a custom logo for your space
    - space settings can override user settings for theming
    - spaces can upload custom CSS overrides
    - allow users to disable showing the tandoor/space logo
    - allow changing navigation background color to any color desired
    - allow switching navigation text color between dark/light (different effects depending on theme)

cookbook/admin.py

@@ -60,9 +60,9 @@ class UserSpaceAdmin(admin.ModelAdmin):
 
 
 class UserPreferenceAdmin(admin.ModelAdmin):
-    list_display = ('name', 'theme', 'nav_color', 'default_page')
+    list_display = ('name', 'theme', 'default_page')
     search_fields = ('user__username',)
-    list_filter = ('theme', 'nav_color', 'default_page',)
+    list_filter = ('theme', 'default_page',)
     date_hierarchy = 'created_at'
     filter_horizontal = ('plan_share', 'shopping_share',)
 
@@ -75,7 +75,7 @@ def name(obj):
 
 
 class SearchPreferenceAdmin(admin.ModelAdmin):
-    list_display = ('name', 'search', 'trigram_threshold', )
+    list_display = ('name', 'search', 'trigram_threshold',)
     search_fields = ('user__username',)
     list_filter = ('search',)
 
@@ -169,7 +169,7 @@ def delete_unattached_steps(modeladmin, request, queryset):
 
 class StepAdmin(admin.ModelAdmin):
     list_display = ('recipe_and_name', 'order', 'space')
-    ordering = ('recipe__name', 'name', 'space', )
+    ordering = ('recipe__name', 'name', 'space',)
     search_fields = ('name', 'recipe__name')
     actions = [delete_unattached_steps]
 
@@ -198,7 +198,7 @@ def rebuild_index(modeladmin, request, queryset):
 class RecipeAdmin(admin.ModelAdmin):
     list_display = ('name', 'internal', 'created_by', 'storage', 'space')
     search_fields = ('name', 'created_by__username')
-    ordering = ('name', 'created_by__username', )
+    ordering = ('name', 'created_by__username',)
     list_filter = ('internal',)
     date_hierarchy = 'created_at'
 
@@ -215,7 +215,7 @@ def created_by(obj):
 
 class UnitAdmin(admin.ModelAdmin):
     list_display = ('name', 'space')
-    ordering = ('name', 'space', )
+    ordering = ('name', 'space',)
     search_fields = ('name',)
 
 

cookbook/forms.py

@@ -33,64 +33,6 @@ def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
 
-class UserPreferenceForm(forms.ModelForm):
-    prefix = 'preference'
-
-    def __init__(self, *args, **kwargs):
-        space = kwargs.pop('space')
-        super().__init__(*args, **kwargs)
-        self.fields['plan_share'].queryset = User.objects.filter(userspace__space=space).all()
-
-    class Meta:
-        model = UserPreference
-        fields = (
-            'default_unit', 'use_fractions', 'use_kj', 'theme', 'nav_color',
-            'sticky_navbar', 'default_page', 'plan_share', 'ingredient_decimals', 'comments', 'left_handed', 'show_step_ingredients',
-        )
-
-        labels = {
-            'default_unit': _('Default unit'),
-            'use_fractions': _('Use fractions'),
-            'use_kj': _('Use KJ'),
-            'theme': _('Theme'),
-            'nav_color': _('Navbar color'),
-            'sticky_navbar': _('Sticky navbar'),
-            'default_page': _('Default page'),
-            'plan_share': _('Plan sharing'),
-            'ingredient_decimals': _('Ingredient decimal places'),
-            'shopping_auto_sync': _('Shopping list auto sync period'),
-            'comments': _('Comments'),
-            'left_handed': _('Left-handed mode'),
-            'show_step_ingredients': _('Show step ingredients table')
-        }
-
-        help_texts = {
-            'nav_color': _('Color of the top navigation bar. Not all colors work with all themes, just try them out!'),
-            'default_unit': _('Default Unit to be used when inserting a new ingredient into a recipe.'),
-            'use_fractions': _(
-                'Enables support for fractions in ingredient amounts (e.g. convert decimals to fractions automatically)'),
-            'use_kj': _('Display nutritional energy amounts in joules instead of calories'),
-            'plan_share': _('Users with whom newly created meal plans should be shared by default.'),
-            'shopping_share': _('Users with whom to share shopping lists.'),
-            'ingredient_decimals': _('Number of decimals to round ingredients.'),
-            'comments': _('If you want to be able to create and see comments underneath recipes.'),
-            'shopping_auto_sync': _(
-                'Setting to 0 will disable auto sync. When viewing a shopping list the list is updated every set seconds to sync changes someone else might have made. Useful when shopping with multiple people but might use a little bit '
-                'of mobile data. If lower than instance limit it is reset when saving.'
-            ),
-            'sticky_navbar': _('Makes the navbar stick to the top of the page.'),
-            'mealplan_autoadd_shopping': _('Automatically add meal plan ingredients to shopping list.'),
-            'mealplan_autoexclude_onhand': _('Exclude ingredients that are on hand.'),
-            'left_handed': _('Will optimize the UI for use with your left hand.'),
-            'show_step_ingredients': _('Add ingredients table next to recipe steps. Applies at creation time for manually created and URL imported recipes. Individual steps can be overridden in the edit recipe view.')
-        }
-
-        widgets = {
-            'plan_share': MultiSelectWidget,
-            'shopping_share': MultiSelectWidget,
-        }
-
-
 class UserNameForm(forms.ModelForm):
     prefix = 'name'
 

cookbook/migrations/0206_rename_sticky_navbar_userpreference_nav_sticky_and_more.py

@@ -0,0 +1,128 @@
+# Generated by Django 4.2.7 on 2024-01-01 18:44
+import django
+from django.db import migrations, models
+from django_scopes import scopes_disabled
+
+TANDOOR = 'TANDOOR'
+TANDOOR_DARK = 'TANDOOR_DARK'
+BOOTSTRAP = 'BOOTSTRAP'
+DARKLY = 'DARKLY'
+FLATLY = 'FLATLY'
+SUPERHERO = 'SUPERHERO'
+
+PRIMARY = 'PRIMARY'
+SECONDARY = 'SECONDARY'
+SUCCESS = 'SUCCESS'
+INFO = 'INFO'
+WARNING = 'WARNING'
+DANGER = 'DANGER'
+LIGHT = 'LIGHT'
+DARK = 'DARK'
+
+
+# ['light', 'warning', 'info', 'success'] --> light (theming_tags L45)
+def get_nav_bg_color(theme, nav_color):
+    if theme == TANDOOR:  # primary not actually primary color but override existed before update, same for dark
+        return {PRIMARY: '#ddbf86', SECONDARY: '#b55e4f', SUCCESS: '#82aa8b', INFO: '#385f84', WARNING: '#eaaa21', DANGER: '#a7240e', LIGHT: '#cfd5cd', DARK: '#221e1e'}[nav_color]
+    if theme == TANDOOR_DARK:
+        return {PRIMARY: '#ddbf86', SECONDARY: '#b55e4f', SUCCESS: '#82aa8b', INFO: '#385f84', WARNING: '#eaaa21', DANGER: '#a7240e', LIGHT: '#cfd5cd', DARK: '#221e1e'}[nav_color]
+    if theme == BOOTSTRAP:
+        return {PRIMARY: '#007bff', SECONDARY: '#6c757d', SUCCESS: '#28a745', INFO: '#17a2b8', WARNING: '#ffc107', DANGER: '#dc3545', LIGHT: '#f8f9fa', DARK: '#343a40'}[nav_color]
+    if theme == DARKLY:
+        return {PRIMARY: '#375a7f', SECONDARY: '#444', SUCCESS: '#00bc8c', INFO: '#3498DB', WARNING: '#F39C12', DANGER: '#E74C3C', LIGHT: '#999', DARK: '#303030'}[nav_color]
+    if theme == FLATLY:
+        return {PRIMARY: '#2C3E50', SECONDARY: '#95a5a6', SUCCESS: '#18BC9C', INFO: '#3498DB', WARNING: '#F39C12', DANGER: '#E74C3C', LIGHT: '#ecf0f1', DARK: '#7b8a8b'}[nav_color]
+    if theme == SUPERHERO:
+        return {PRIMARY: '#DF691A', SECONDARY: '#4E5D6C', SUCCESS: '#5cb85c', INFO: '#5bc0de', WARNING: '#f0ad4e', DANGER: '#d9534f', LIGHT: '#abb6c2', DARK: '#4E5D6C'}[nav_color]
+
+
+def get_nav_text_color(theme, nav_color):
+    if theme == TANDOOR:
+        return {PRIMARY: DARK, SECONDARY: DARK, SUCCESS: DARK, INFO: DARK, WARNING: DARK, DANGER: DARK, LIGHT: DARK, DARK: DARK}[nav_color]
+    if theme == TANDOOR_DARK:
+        return {PRIMARY: DARK, SECONDARY: DARK, SUCCESS: DARK, INFO: DARK, WARNING: DARK, DANGER: DARK, LIGHT: DARK, DARK: DARK}[nav_color]
+    if theme == BOOTSTRAP:
+        return {PRIMARY: DARK, SECONDARY: DARK, SUCCESS: DARK, INFO: DARK, WARNING: DARK, DANGER: DARK, LIGHT: DARK, DARK: DARK}[nav_color]
+    if theme == DARKLY:
+        return {PRIMARY: DARK, SECONDARY: DARK, SUCCESS: DARK, INFO: DARK, WARNING: DARK, DANGER: DARK, LIGHT: DARK, DARK: DARK}[nav_color]
+    if theme == FLATLY:
+        return {PRIMARY: DARK, SECONDARY: DARK, SUCCESS: LIGHT, INFO: LIGHT, WARNING: LIGHT, DANGER: DARK, LIGHT: LIGHT, DARK: DARK}[nav_color]
+    if theme == SUPERHERO:
+        return {PRIMARY: DARK, SECONDARY: DARK, SUCCESS: LIGHT, INFO: LIGHT, WARNING: LIGHT, DANGER: DARK, LIGHT: LIGHT, DARK: DARK}[nav_color]
+
+
+def get_current_colors(apps, schema_editor):
+    with scopes_disabled():
+        # in case any food had a non digit fdc ID before this migration, remove it
+        UserPreference = apps.get_model('cookbook', 'UserPreference')
+
+        update_ups = []
+        for up in UserPreference.objects.all():
+            if up.theme != TANDOOR or up.nav_color != PRIMARY:
+                up.nav_bg_color = get_nav_bg_color(up.theme, up.nav_color)
+                up.nav_text_color = get_nav_text_color(up.theme, up.nav_color)
+                up.nav_show_logo = (up.theme == TANDOOR or up.theme == TANDOOR_DARK)
+                update_ups.append(up)
+
+        UserPreference.objects.bulk_update(update_ups, ['nav_bg_color', 'nav_text_color', 'nav_show_logo'])
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('cookbook', '0205_alter_food_fdc_id_alter_propertytype_fdc_id'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='userpreference',
+            old_name='sticky_navbar',
+            new_name='nav_sticky',
+        ),
+        migrations.AddField(
+            model_name='userpreference',
+            name='nav_bg_color',
+            field=models.CharField(default='#ddbf86', max_length=8),
+        ),
+        migrations.AddField(
+            model_name='userpreference',
+            name='nav_text_color',
+            field=models.CharField(choices=[('LIGHT', 'Light'), ('DARK', 'Dark')], default='DARK', max_length=16),
+        ),
+        migrations.AddField(
+            model_name='userpreference',
+            name='nav_show_logo',
+            field=models.BooleanField(default=True),
+        ),
+        migrations.RunPython(get_current_colors),
+        migrations.RemoveField(
+            model_name='userpreference',
+            name='nav_color',
+        ),
+        migrations.AddField(
+            model_name='space',
+            name='nav_bg_color',
+            field=models.CharField(blank=True, default='', max_length=8),
+        ),
+        migrations.AddField(
+            model_name='space',
+            name='nav_logo',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='space_nav_logo', to='cookbook.userfile'),
+        ),
+        migrations.AddField(
+            model_name='space',
+            name='nav_text_color',
+            field=models.CharField(choices=[('BLANK', '-------'), ('LIGHT', 'Light'), ('DARK', 'Dark')], default='BLANK', max_length=16),
+        ),
+        migrations.AddField(
+            model_name='space',
+            name='space_theme',
+            field=models.CharField(choices=[('BLANK', '-------'), ('TANDOOR', 'Tandoor'), ('BOOTSTRAP', 'Bootstrap'), ('DARKLY', 'Darkly'), ('FLATLY', 'Flatly'), ('SUPERHERO', 'Superhero'), ('TANDOOR_DARK', 'Tandoor Dark (INCOMPLETE)')],
+                                   default='BLANK',
+                                   max_length=128),
+        ),
+        migrations.AddField(
+            model_name='space',
+            name='custom_space_theme',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='space_theme', to='cookbook.userfile'),
+        ),
+    ]

cookbook/models.py

@@ -251,8 +251,44 @@ def get_name(self):
 
 
 class Space(ExportModelOperationsMixin('space'), models.Model):
+    # TODO remove redundant theming constants
+    # Themes
+    BLANK = 'BLANK'
+    TANDOOR = 'TANDOOR'
+    TANDOOR_DARK = 'TANDOOR_DARK'
+    BOOTSTRAP = 'BOOTSTRAP'
+    DARKLY = 'DARKLY'
+    FLATLY = 'FLATLY'
+    SUPERHERO = 'SUPERHERO'
+
+    THEMES = (
+        (BLANK, '-------'),
+        (TANDOOR, 'Tandoor'),
+        (BOOTSTRAP, 'Bootstrap'),
+        (DARKLY, 'Darkly'),
+        (FLATLY, 'Flatly'),
+        (SUPERHERO, 'Superhero'),
+        (TANDOOR_DARK, 'Tandoor Dark (INCOMPLETE)'),
+    )
+
+    LIGHT = 'LIGHT'
+    DARK = 'DARK'
+
+    NAV_TEXT_COLORS = (
+        (BLANK, '-------'),
+        (LIGHT, 'Light'),
+        (DARK, 'Dark')
+    )
+
     name = models.CharField(max_length=128, default='Default')
+
     image = models.ForeignKey("UserFile", on_delete=models.SET_NULL, null=True, blank=True, related_name='space_image')
+    space_theme = models.CharField(choices=THEMES, max_length=128, default=TANDOOR)
+    custom_space_theme = models.ForeignKey("UserFile", on_delete=models.SET_NULL, null=True, blank=True, related_name='space_theme')
+    nav_logo = models.ForeignKey("UserFile", on_delete=models.SET_NULL, null=True, blank=True, related_name='space_nav_logo')
+    nav_bg_color = models.CharField(max_length=8, default='', blank=True, )
+    nav_text_color = models.CharField(max_length=16, choices=NAV_TEXT_COLORS, default=DARK)
+
     created_by = models.ForeignKey(User, on_delete=models.PROTECT, null=True)
     created_at = models.DateTimeField(auto_now_add=True)
     message = models.CharField(max_length=512, default='', blank=True)
@@ -338,22 +374,10 @@ class UserPreference(models.Model, PermissionModelMixin):
     )
 
     # Nav colors
-    PRIMARY = 'PRIMARY'
-    SECONDARY = 'SECONDARY'
-    SUCCESS = 'SUCCESS'
-    INFO = 'INFO'
-    WARNING = 'WARNING'
-    DANGER = 'DANGER'
     LIGHT = 'LIGHT'
     DARK = 'DARK'
 
-    COLORS = (
-        (PRIMARY, 'Primary'),
-        (SECONDARY, 'Secondary'),
-        (SUCCESS, 'Success'),
-        (INFO, 'Info'),
-        (WARNING, 'Warning'),
-        (DANGER, 'Danger'),
+    NAV_TEXT_COLORS = (
         (LIGHT, 'Light'),
         (DARK, 'Dark')
     )
@@ -371,8 +395,13 @@ class UserPreference(models.Model, PermissionModelMixin):
 
     user = AutoOneToOneField(User, on_delete=models.CASCADE, primary_key=True)
     image = models.ForeignKey("UserFile", on_delete=models.SET_NULL, null=True, blank=True, related_name='user_image')
+
     theme = models.CharField(choices=THEMES, max_length=128, default=TANDOOR)
-    nav_color = models.CharField(choices=COLORS, max_length=128, default=PRIMARY)
+    nav_bg_color = models.CharField(max_length=8, default='#ddbf86')
+    nav_text_color = models.CharField(max_length=16, choices=NAV_TEXT_COLORS, default=DARK)
+    nav_show_logo = models.BooleanField(default=True)
+    nav_sticky = models.BooleanField(default=STICKY_NAV_PREF_DEFAULT)
+
     default_unit = models.CharField(max_length=32, default='g')
     use_fractions = models.BooleanField(default=FRACTION_PREF_DEFAULT)
     use_kj = models.BooleanField(default=KJ_PREF_DEFAULT)
@@ -382,7 +411,6 @@ class UserPreference(models.Model, PermissionModelMixin):
     ingredient_decimals = models.IntegerField(default=2)
     comments = models.BooleanField(default=COMMENT_PREF_DEFAULT)
     shopping_auto_sync = models.IntegerField(default=5)
-    sticky_navbar = models.BooleanField(default=STICKY_NAV_PREF_DEFAULT)
     mealplan_autoadd_shopping = models.BooleanField(default=False)
     mealplan_autoexclude_onhand = models.BooleanField(default=True)
     mealplan_autoinclude_related = models.BooleanField(default=True)

cookbook/serializer.py

@@ -212,7 +212,7 @@ def get_preview_link(self, obj):
             Image.open(obj.file.file.file)
             return self.context['request'].build_absolute_uri(obj.file.url)
         except Exception:
-            traceback.print_exc()
+            # traceback.print_exc()
             return ""
 
     def check_file_limit(self, validated_data):
@@ -260,7 +260,7 @@ def get_preview_link(self, obj):
             Image.open(obj.file.file.file)
             return self.context['request'].build_absolute_uri(obj.file.url)
         except Exception:
-            traceback.print_exc()
+            # traceback.print_exc()
             return ""
 
     def create(self, validated_data):
@@ -281,6 +281,8 @@ class SpaceSerializer(WritableNestedModelSerializer):
     file_size_mb = serializers.SerializerMethodField('get_file_size_mb')
     food_inherit = FoodInheritFieldSerializer(many=True)
     image = UserFileViewSerializer(required=False, many=False, allow_null=True)
+    nav_logo = UserFileViewSerializer(required=False, many=False, allow_null=True)
+    custom_space_theme = UserFileViewSerializer(required=False, many=False, allow_null=True)
 
     def get_user_count(self, obj):
         return UserSpace.objects.filter(space=obj).count()
@@ -302,7 +304,7 @@ class Meta:
         fields = (
             'id', 'name', 'created_by', 'created_at', 'message', 'max_recipes', 'max_file_storage_mb', 'max_users',
             'allow_sharing', 'demo', 'food_inherit', 'user_count', 'recipe_count', 'file_size_mb',
-            'image', 'use_plural',)
+            'image', 'nav_logo', 'space_theme', 'custom_space_theme', 'nav_bg_color', 'nav_text_color', 'use_plural',)
         read_only_fields = (
             'id', 'created_by', 'created_at', 'max_recipes', 'max_file_storage_mb', 'max_users', 'allow_sharing',
             'demo',)
@@ -372,8 +374,8 @@ def create(self, validated_data):
     class Meta:
         model = UserPreference
         fields = (
-            'user', 'image', 'theme', 'nav_color', 'default_unit', 'default_page', 'use_fractions', 'use_kj',
-            'plan_share', 'sticky_navbar',
+            'user', 'image', 'theme', 'nav_bg_color', 'nav_text_color', 'nav_show_logo', 'default_unit', 'default_page', 'use_fractions', 'use_kj',
+            'plan_share', 'nav_sticky',
             'ingredient_decimals', 'comments', 'shopping_auto_sync', 'mealplan_autoadd_shopping',
             'food_inherit_default', 'default_delay',
             'mealplan_autoinclude_related', 'mealplan_autoexclude_onhand', 'shopping_share', 'shopping_recent_days',