Merge pull request #96 from benoitblanc/feat/disable-theme

Allow to disable themes in configuration

Author: benoitblanc

src/plugins/themes/controllers/themes_controller.py

@@ -139,7 +139,8 @@ def index(self):
         for item in self.themesconfig["themes"].get("items", []):
             themes["items"].append({
                 "name": item["title"] if "title" in item else item["url"],
-                "url": item["url"]
+                "url": item["url"],
+                "disabled": item.get("disabled", False)
             })
 
         # TODO: nested groups
@@ -151,7 +152,8 @@ def index(self):
             for item in group["items"]:
                 groupEntry["items"].append({
                     "name": item["title"] if "title" in item else item["url"],
-                    "url": item["url"]
+                    "url": item["url"],
+                    "disabled": item.get("disabled", False)
                 })
             themes["groups"].append(groupEntry)
 
@@ -440,6 +442,8 @@ def create_form(self, theme=None):
                 form.url.data = None
             if "title" in theme:
                 form.title.data = theme["title"]
+            if "disabled" in theme:
+                form.disabled.data = theme["disabled"]
             if "default" in theme:
                 form.default.data = theme["default"]
             if "tiled" in theme:
@@ -546,6 +550,10 @@ def create_or_update_theme(self, theme, form, tid=None, gid=None):
         else:
             if "title" in item: del item["title"]
 
+        item["disabled"] = False
+        if form.disabled.data:
+            item["disabled"] = True
+
         item["default"] = False
         if form.default.data:
             item["default"] = True

src/plugins/themes/forms/theme_form.py

@@ -119,6 +119,11 @@ class ThemeForm(FlaskForm):
         description=i18n('plugins.themes.theme.form_collapseLayerGroupsBelowLevel_description'),
         validators=[Optional()]
     )
+    disabled = BooleanField(
+        i18n('plugins.themes.theme.form_disabled'),
+        description=i18n('plugins.themes.theme.form_disabled_description'),
+        validators=[Optional()]
+    )
     default = BooleanField(
         i18n('plugins.themes.theme.form_default'),
         description=i18n('plugins.themes.theme.form_default_description'),

src/plugins/themes/templates/theme.html

@@ -225,6 +225,7 @@ <h1>{{ title }}</h1>
     {{ wtf.render_field(form.printResolutions, form_type="horizontal", horizontal_columns=('sm', 2, 5)) }}
     {{ wtf.render_field(form.printLabelBlacklist, form_type="horizontal", horizontal_columns=('sm', 2, 5)) }}
     {{ wtf.render_field(form.collapseLayerGroupsBelowLevel, form_type="horizontal", horizontal_columns=('sm', 2, 5)) }}
+    {{ wtf.render_field(form.disabled, form_type="horizontal", horizontal_columns=('sm', 0, 7)) }}
     {{ wtf.render_field(form.default, form_type="horizontal", horizontal_columns=('sm', 0, 7)) }}
     {{ wtf.render_field(form.tiled, form_type="horizontal", horizontal_columns=('sm', 0, 7)) }}
     {{ wtf.render_field(form.mapTips, form_type="horizontal", horizontal_columns=('sm', 0, 7)) }}

src/plugins/themes/templates/themes.html

@@ -52,15 +52,26 @@ <h3>{{ i18n('plugins.themes.themes.themes') }}</h3>
               <th>ID</th>
               <th>{{ i18n('plugins.themes.themes.theme') }}</th>
               <th>{{ i18n('interface.common.url') }}</th>
+              <th>{{ i18n('plugins.themes.themes.disabled') }}</th>
               <th></th>
               <th></th>
             </thead>
             <tbody>
             {% for item in list %}
               <tr>
-                <td style="vertical-align: middle">{{ loop.index }}</td>
-                <td style="vertical-align: middle">{{ item.name }}</td>
-                <td style="vertical-align: middle">{{ item.url }}</td>
+                <td {% if item.disabled %}class="text-muted"{% endif %} style="vertical-align: middle">{{ loop.index }}</td>
+                <td {% if item.disabled %}class="text-muted"{% endif %} style="vertical-align: middle">{{ item.name }}</td>
+                <td {% if item.disabled %}class="text-muted"{% endif %} style="vertical-align: middle">{{ item.url }}</td>
+                <td style="vertical-align: middle">
+                  <input class="form-check-input"
+                    id="disable-theme-{{ item.name }}"
+                    name="disable-theme-{{ item.name }}"
+                    type="checkbox" disabled value="disabled"
+                    {% if item.disabled %}
+                    checked
+                    {% endif %}
+                    />
+                </td>
                 <td>
                   <a href="#" onclick="copyToClipboard('{{ item.url }}')" class="btn btn-default copy" role="button" title="{{ i18n('plugins.themes.themes.copy_url') }}">
                     {{ utils.render_icon('copy') }}
@@ -140,15 +151,26 @@ <h3>{{ i18n('plugins.themes.themes.theme_groups') }}</h3>
                   <th>ID</th>
                   <th>{{ i18n('plugins.themes.themes.theme') }}</th>
                   <th>{{ i18n('interface.common.url') }}</th>
+                  <th>{{ i18n('plugins.themes.themes.disabled') }}</th>
                   <th></th>
                   <th></th>
                 </thead>
                 <tbody>
                 {% for item in group["items"] %}
                   <tr>
-                    <td style="vertical-align: middle">{{ loop.index }}</td>
-                    <td style="vertical-align: middle">{{ item.name }}</td>
-                    <td style="vertical-align: middle">{{ item.url }}</td>
+                    <td {% if item.disabled %}class="text-muted"{% endif %} style="vertical-align: middle">{{ loop.index }}</td>
+                    <td {% if item.disabled %}class="text-muted"{% endif %} style="vertical-align: middle">{{ item.name }}</td>
+                    <td {% if item.disabled %}class="text-muted"{% endif %} style="vertical-align: middle">{{ item.url }}</td>
+                    <td style="vertical-align: middle">
+                      <input class="form-check-input"
+                        id="disable-theme-{{ item.name }}"
+                        name="disable-theme-{{ item.name }}"
+                        type="checkbox" disabled value="disabled"
+                        {% if item.disabled %}
+                        checked
+                        {% endif %}
+                        />
+                    </td>
                     <td>
                       <a href="#" onclick="copyToClipboard('{{ item.url }}')" class="btn btn-default copy" role="button" title="{{ i18n('plugins.themes.themes.copy_url') }}">
                         {{ utils.render_icon('copy') }}

src/translations/de.json

@@ -185,9 +185,6 @@
       "title": "Konfigurationseditor",
       "update_message_success": "wurde aktualisiert"
     },
-    "json_editor": {
-      "title": "title"
-    },
     "themes": {
       "backgroundlayers": {
         "action_created": "erstellt",
@@ -285,6 +282,8 @@
         "form_crs_description": "Die Kartenprojektion.",
         "form_default": "Standard",
         "form_default_description": "Ob dieses Thema als Initialthema verwendet werden soll.",
+        "form_disabled": "Deaktivieren",
+        "form_disabled_description": "Dieses Thema beim Konfigurieren überspringen",
         "form_format_description": "Über WMS angefragtes Bildformat. Standard ist 'image/png'.",
         "form_mapTips": "Kartentips standardmässig aktivieren",
         "form_mapTips_description": "Kartentips standardmässig aktivieren",
@@ -321,6 +320,7 @@
         "create_theme_title": "Thema erstellen",
         "delete_theme": "Thema löschen",
         "delete_theme_message_error": "Konnte die Ressource für das Thema nicht löschen",
+        "disabled": "Deaktiviert",
         "edit_theme": "Thema editieren",
         "edit_theme_title": "Thema editieren",
         "group_confirm_message_delete": "Themengruppe wirklich löschen?",

src/translations/en.json

@@ -185,9 +185,6 @@
       "title": "Config Editor",
       "update_message_success": "has been updated"
     },
-    "json_editor": {
-      "title": "title"
-    },
     "themes": {
       "backgroundlayers": {
         "action_created": "created",
@@ -285,6 +282,8 @@
         "form_crs_description": "The map projection.",
         "form_default": "Default",
         "form_default_description": "Whether to use this theme as initial theme.",
+        "form_disabled": "Disable this theme",
+        "form_disabled_description": "Skip this theme from configuration.",
         "form_format_description": "Image format requested from the WMS Service. Default is 'image/png'.",
         "form_mapTips": "Enable tooltip by default",
         "form_mapTips_description": "Enable the theme tooltip by default",
@@ -321,6 +320,7 @@
         "create_theme_title": "Create theme",
         "delete_theme": "Delete theme",
         "delete_theme_message_error": "Could not delete resource for map",
+        "disabled": "Disabled",
         "edit_theme": "Edit theme",
         "edit_theme_title": "Edit theme",
         "group_confirm_message_delete": "Really delete theme group?",

src/translations/fr.json

@@ -185,9 +185,6 @@
       "title": "Editeur des configurations",
       "update_message_success": "a été mis à jour"
     },
-    "json_editor": {
-      "title": "title"
-    },
     "themes": {
       "backgroundlayers": {
         "action_created": "créé",
@@ -285,6 +282,8 @@
         "form_crs_description": "Projection de la carte.",
         "form_default": "Par défaut",
         "form_default_description": "Utiliser ce thème comme thème ouvert par défaut.",
+        "form_disabled": "Désactiver ce thème",
+        "form_disabled_description": "Ne pas prendre en compte ce thème dans la configuration.",
         "form_format_description": "Le format d'image est obligatoire pour le service WMS. Par défaut, 'image/png'.",
         "form_mapTips": "Activer l'infobulle par défaut",
         "form_mapTips_description": "Activer l'infobulle par défaut sur ce thème",
@@ -321,6 +320,7 @@
         "create_theme_title": "Créer un thème",
         "delete_theme": "Supprimer un thème",
         "delete_theme_message_error": "Impossible de supprimer la ressource pour la carte",
+        "disabled": "Désactivé",
         "edit_theme": "Modifier le thème",
         "edit_theme_title": "Modifier le thème",
         "group_confirm_message_delete": "Voulez-vous vraiment supprimer ce groupe de thèmes?",

src/translations/tsconfig.json

@@ -169,7 +169,6 @@
     "plugins.config_editor.subtitle",
     "plugins.config_editor.title",
     "plugins.config_editor.update_message_success",
-    "plugins.json_editor.title",
     "plugins.themes.backgroundlayers.action_created",
     "plugins.themes.backgroundlayers.action_updated",
     "plugins.themes.backgroundlayers.create_message_error",
@@ -255,6 +254,8 @@
     "plugins.themes.theme.form_crs_description",
     "plugins.themes.theme.form_default",
     "plugins.themes.theme.form_default_description",
+    "plugins.themes.theme.form_disabled",
+    "plugins.themes.theme.form_disabled_description",
     "plugins.themes.theme.form_format_description",
     "plugins.themes.theme.form_mapTips",
     "plugins.themes.theme.form_mapTips_description",
@@ -289,6 +290,7 @@
     "plugins.themes.themes.create_theme_title",
     "plugins.themes.themes.delete_theme",
     "plugins.themes.themes.delete_theme_message_error",
+    "plugins.themes.themes.disabled",
     "plugins.themes.themes.edit_theme",
     "plugins.themes.themes.edit_theme_title",
     "plugins.themes.themes.group_confirm_message_delete",