Add configurable home route (#25)

Author: frankdekker

README.md

@@ -83,4 +83,5 @@ By default, the application is available at: `{APP_URL}/log-viewer`.
 - [Modifying monolog configuration](docs/modifying-monolog-configuration.md)
 - [Disabling the default monolog configuration](docs/disabling-default-monolog-configuration.md)
 - [Adding additional log files](docs/adding-additional-log-files.md)
+- [Configuring the back home url](docs/configuring-the-back-home-route.md)
 - [Full configuration reference](docs/configuration-reference.md)

docs/configuration-reference.md

@@ -7,6 +7,7 @@ Out of the box, [Log viewer](../README.md) will have the following configuration
 ```yaml
 fd_log_viewer:
     enable_default_monolog: true
+    home_route: null
 
     log_files:
         monolog:
@@ -35,6 +36,13 @@ fd_log_viewer:
 Out of the box the bundle is configured with a default monolog configuration. Set this to `false` to override this behaviour.
 <br><br>
 
+### home_route
+
+**type**: `string|null`. Default: `null`
+
+The name of the route that will be used as url for the back button. If null the back button will redirect to `https://your-domain/`.
+<br><br>
+
 ### log_files
 
 **type**: `array<string, mixed>`

docs/configuring-the-back-home-route.md

@@ -0,0 +1,9 @@
+## Configuring the home route
+
+By default, the back button will redirect to the `/` route. You can change this by setting the `home_route` option in the configuration:
+
+```yaml
+# config/packages/fd_log_viewer.yaml
+fd_log_viewer:
+  home_route: App\Controller\HomeController
+```

frontend/src/LogViewer.vue

@@ -2,16 +2,20 @@
 import FileTree from '@/components/FileTree.vue'
 import {useRoute} from 'vue-router';
 
-const route = useRoute();
+const route   = useRoute();
+const homeUri = document.head.querySelector<HTMLMetaElement>('[name=home-uri]')!.content;
 </script>
 
 <template>
     <div class="slv-sidebar h-100 overflow-hidden">
-        <header class="slv-header-height bg-body">
-            <h3 class="d-block text-center slv-app-title">
+        <header class="slv-header-height slv-header bg-body position-relative">
+            <a :href="homeUri" class="slv-back text-decoration-none">
+                <i class="bi bi-arrow-left-short"></i>Back
+            </a>
+
+            <h4 class="d-block text-center slv-app-title m-0">
                 <i class="bi bi-substack slv-icon-color"></i>
-                Log viewer
-            </h3>
+                Log viewer </h4>
         </header>
 
         <FileTree/>
@@ -20,11 +24,24 @@ const route = useRoute();
 </template>
 
 <style scoped>
+.slv-app-title {
+    color: rgb(2, 132, 199);
+    height: var(--slv-min-header-height);
+    line-height: var(--slv-min-header-height);
+}
+
 .slv-sidebar {
     display: grid;
     grid-template-rows: auto 1fr;
 }
 
+.slv-back {
+    position: absolute;
+    left: 0;
+    height: var(--slv-min-header-height);
+    line-height: var(--slv-min-header-height);
+}
+
 .slv-icon-color {
     color: #fff;
 }

frontend/src/assets/main.scss

@@ -30,16 +30,13 @@
     }
 }
 
-.slv-app-title {
-    color: rgb(2, 132, 199)
-}
-
 .slv-body-grid {
     display: grid;
     grid-template-columns: minmax(var(--slv-min-sidebar-width), min(25%, var(--slv-max-sidebar-width))) 1fr;
 }
 
 .slv-header-height {
+    box-sizing: border-box;
     min-height: var(--slv-min-header-height);
 }
 

frontend/src/main.ts

@@ -18,5 +18,4 @@ const app = createApp(LogViewer);
 
 app.use(createPinia());
 app.use(router(baseUri));
-
 app.mount('#log-viewer');

src/Controller/IndexController.php

@@ -14,6 +14,7 @@
 class IndexController extends AbstractController
 {
     public function __construct(
+        private readonly ?string $homeRoute,
         private readonly JsonManifestAssetLoader $assetLoader,
         private readonly RouteService $routeService,
         private readonly LogFolderOutputProvider $folderOutputProvider
@@ -34,9 +35,10 @@ public function __invoke(): Response
         return $this->render(
             '@FDLogViewer/index.html.twig',
             [
-                'base_uri' => $baseUri,
-                'folders'  => $folders,
-                'assets'   => [
+                'base_uri'   => $baseUri,
+                'home_route' => $this->homeRoute,
+                'folders'    => $folders,
+                'assets'     => [
                     'style' => $this->assetLoader->getUrl('style.css'),
                     'js'    => $this->assetLoader->getUrl('src/main.ts')
                 ],

src/DependencyInjection/Configuration.php

@@ -33,6 +33,9 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->scalarNode('type')
                         ->info("The type of log file: monolog, nginx, apache, or the service id of an implementation of `LogFileParserInterface`")
                     ->end()
+                    ->scalarNode('home_route')
+                        ->info("The name of the route to redirect to when clicking the back button")
+                    ->end()
                     ->scalarNode('name')->info("The pretty name to show for these log files")->defaultNull()->end()
                     ->arrayNode('finder')
                         ->children()

src/DependencyInjection/Extension.php

@@ -48,6 +48,8 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $mergedConfigs = $this->processConfiguration(new Configuration(), $configs);
 
+        $container->setParameter('fd.symfony.log.viewer.log_files_config.home_route', $mergedConfigs['home_route'] ?? null);
+
         // add defaults
         if ($mergedConfigs['enable_default_monolog']) {
             $mergedConfigs = Arrays::merge($mergedConfigs, self::DEFAULT_MONOLOG_CONFIG);

src/Resources/config/services.php

@@ -40,7 +40,9 @@
         ->autowire()
         ->autoconfigure();
 
-    $services->set(IndexController::class)->tag('controller.service_arguments');
+    $services->set(IndexController::class)
+        ->arg('$homeRoute', '%fd.symfony.log.viewer.log_files_config.home_route%')
+        ->tag('controller.service_arguments');
     $services->set(FoldersController::class)->tag('controller.service_arguments');
     $services->set(LogRecordsController::class)->tag('controller.service_arguments');
     $services->set(DownloadFileController::class)->tag('controller.service_arguments');