Add env option to disable part image overlay (#960)

* Add env option to disable part image overlay

Fixes #369 while preserving the state as-is

* Added documentation and use 1 instead of true for new env

---------

Co-authored-by: Jan Böhmer <mail@jan-boehmer.de>

.docker/symfony.conf

@@ -47,6 +47,7 @@
         PassEnv PROVIDER_REICHELT_ENABLED PROVIDER_REICHELT_CURRENCY PROVIDER_REICHELT_COUNTRY PROVIDER_REICHELT_LANGUAGE PROVIDER_REICHELT_INCLUDE_VAT
         PassEnv PROVIDER_POLLIN_ENABLED
         PassEnv EDA_KICAD_CATEGORY_DEPTH
+        PassEnv SHOW_PART_IMAGE_OVERLAY
 
         # For most configuration files from conf-available/, which are
         # enabled or disabled at a global level, it is possible to

.env

@@ -305,6 +305,9 @@ FIXER_API_KEY=CHANGEME
 # When this is empty the content of config/banner.md is used as banner
 BANNER=""
 
+# Enable the part image overlay which shows name and filename of the picture
+SHOW_PART_IMAGE_OVERLAY=1
+
 APP_ENV=prod
 APP_SECRET=a03498528f5a5fc089273ec9ae5b2849
 

config/packages/twig.yaml

@@ -21,6 +21,7 @@ twig:
         available_themes: '%partdb.available_themes%'
         saml_enabled: '%partdb.saml.enabled%'
         part_preview_generator: '@App\Services\Attachments\PartPreviewGenerator'
+        img_overlay: '%partdb.show_part_image_overlay%'
 
 when@test:
     twig:

config/parameters.yaml

@@ -74,6 +74,7 @@ parameters:
   # Miscellaneous
   ######################################################################################################################
   partdb.demo_mode: '%env(bool:DEMO_MODE)%'                   # If set to true, all potentially dangerous things are disabled (like changing passwords of the own user)
+  partdb.show_part_image_overlay: '%env(bool:SHOW_PART_IMAGE_OVERLAY)%' # If set to false, the filename overlay of the part image will be disabled
 
   # Set the themes from which the user can choose from in the settings.
   # Themes commented here by default, are not really usable, because of display problems. Enable them at your own risk!

docs/configuration.md

@@ -95,6 +95,8 @@ bundled with Part-DB. Set `DATABASE_MYSQL_SSL_VERIFY_CERT` if you want to accept
   particularly for securing and protecting various aspects of your application. It's a secret key that is used for
   cryptographic operations and security measures (session management, CSRF protection, etc..). Therefore this
   value should be handled as confidential data and not shared publicly.
+* `SHOW_PART_IMAGE_OVERLAY`: Set to 0 to disable the part image overlay, which appears if you hover over an image in the
+  part image gallery
 
 ### E-Mail settings
 

src/Services/Trees/TreeViewGenerator.php

@@ -63,7 +63,8 @@ class TreeViewGenerator
         private readonly UrlGeneratorInterface $router,
         protected bool $rootNodeExpandedByDefault,
         protected bool $rootNodeEnabled,
-
+        //TODO: Make this configurable in the future
+        protected bool $rootNodeRedirectsToNewEntity = false,
     ) {
     }
 
@@ -174,10 +175,7 @@ class TreeViewGenerator
         }
 
         if (($mode === 'list_parts_root' || $mode === 'devices') && $this->rootNodeEnabled) {
-            //We show the root node as a link to the list of all parts
+            $root_node = new TreeViewNode($this->entityClassToRootNodeString($class), $this->entityClassToRootNodeHref($class), $generic);
-            $show_all_parts_url = $this->router->generate('parts_show_all');
-
-            $root_node = new TreeViewNode($this->entityClassToRootNodeString($class), $show_all_parts_url, $generic);
             $root_node->setExpanded($this->rootNodeExpandedByDefault);
             $root_node->setIcon($this->entityClassToRootNodeIcon($class));
 
@@ -187,6 +185,27 @@ class TreeViewGenerator
         return array_merge($head, $generic);
     }
 
+    protected function entityClassToRootNodeHref(string $class): ?string
+    {
+        //If the root node should redirect to the new entity page, we return the URL for the new entity.
+        if ($this->rootNodeRedirectsToNewEntity) {
+            return match ($class) {
+                Category::class => $this->router->generate('category_new'),
+                StorageLocation::class => $this->router->generate('store_location_new'),
+                Footprint::class => $this->router->generate('footprint_new'),
+                Manufacturer::class => $this->router->generate('manufacturer_new'),
+                Supplier::class => $this->router->generate('supplier_new'),
+                Project::class => $this->router->generate('project_new'),
+                default => null,
+            };
+        }
+
+        return match ($class) {
+            Project::class => $this->router->generate('project_new'),
+            default => $this->router->generate('parts_show_all')
+        };
+    }
+
     protected function entityClassToRootNodeString(string $class): string
     {
         return match ($class) {

templates/parts/info/_picture.html.twig

@@ -13,6 +13,7 @@
                 <div class="carousel-item  {% if loop.first %}active{% endif %}">
                     <a href="{{ entity_url(pic, 'file_view') }}" data-turbo="false" target="_blank" rel="noopener">
                         <img class="d-block w-100 img-fluid img-thumbnail bg-light part-info-image" src="{{ entity_url(pic, 'file_view') }}" alt="">
+                        {% if img_overlay %}
                         <div class="mask"></div>
                         <div class="carousel-caption-hover">
                             <div class="carousel-caption text-white">
@@ -21,6 +22,7 @@
                                 <div>{{ entity_type_label(pic.element) }}</div>
                             </div>
                         </div>
+                        {% endif %}
                     </a>
                 </div>
             {% endfor %}