Merge pull request #16 from NBISweden/search-function

Search function

.dockerignore

@@ -1,3 +1,3 @@
 web/content/datasets/*
 charts/
-dev_utils/
+dev_utils/*

.gitignore

@@ -1,4 +1,4 @@
 web/public/*
 web/content/datasets/test*                      
 web/data/*
-dev_utils/config.yaml
+web/static/pagefind/*

Dockerfile

@@ -8,6 +8,10 @@ RUN go build -o app .
 
 FROM alpine:3.17
 RUN apk add --no-cache --repository=https://dl-cdn.alpinelinux.org/alpine/edge/community hugo
+RUN wget https://github.com/CloudCannon/pagefind/releases/download/v1.1.0/pagefind-v1.1.0-x86_64-unknown-linux-musl.tar.gz && \
+    tar -xvf pagefind-v1.1.0-x86_64-unknown-linux-musl.tar.gz && \
+    mv pagefind /usr/bin && \
+    rm pagefind-v1.1.0-x86_64-unknown-linux-musl.tar.gz
 COPY --from=build /lp_app/app .
 COPY --from=build /lp_app/web web/
 CMD ["./app"]

download_metadata.go

@@ -35,11 +35,9 @@ func metadataDownloader(Metadataclient *MetadataBackend) {
 			err := downloadToFile(manager, LocalDirectory, Bucket, aws.ToString(obj.Key))
 			if err != nil {
 				log.Fatal("Error while downloading metadata files from metadata bucket", err)
-			} else {
-				log.Infoln("Completed downloading metadatafiles")
-
 			}
 		}
+		log.Infoln("Completed downloading metadata files")
 
 	}
 

header_extractor.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"encoding/xml"
+	"log"
+	"os"
+)
+
+// Struct definitions
+type LandingPageSet struct {
+	LandingPage LandingPage `xml:"LANDING_PAGE"`
+}
+
+type LandingPage struct {
+	Attributes Attributes `xml:"ATTRIBUTES"`
+}
+
+type Attributes struct {
+	StringAttributes []StringAttribute `xml:"STRING_ATTRIBUTE"`
+}
+
+type StringAttribute struct {
+	Tag   string `xml:"TAG"`
+	Value string `xml:"VALUE"`
+}
+
+// Function to extract header value from XML content
+func getHeaderValueFromXMLContent(xmlContent []byte) (string, error) {
+	var landingPageSet LandingPageSet
+	err := xml.Unmarshal(xmlContent, &landingPageSet)
+	if err != nil {
+		log.Fatal("Unmarshalling XML file for header failed", err)
+	}
+
+	// Iterate over the string attributes to find the header value
+	for _, attr := range landingPageSet.LandingPage.Attributes.StringAttributes {
+		if attr.Tag == "header" {
+			return attr.Value, nil
+		}
+	}
+	return "sf", err
+
+}
+
+// Function to read the XML file and return its content
+func readXMLFile(filePath string) ([]byte, error) {
+	return os.ReadFile(filePath)
+}

main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"os"
 	"os/exec"
 
 	log "github.com/sirupsen/logrus"
@@ -11,16 +12,28 @@ func main() {
 	log.Infoln("started app successfully")
 	mConf := getMetadataConfig()
 	Metadataclient := connectMetadatas3(mConf)
-	log.Infof("Connection to the bucket established")
+	log.Infof("Writing markdownfiles for respective XMLs")
 	metadataDownloader(Metadataclient)
 	markDownCreator()
-	cmd := exec.Command("hugo")
-	cmd.Dir = "./web/"
-	cmd.Run()
+	hugo_cmd := exec.Command("hugo")
+	hugo_cmd.Dir = "./web/"
+	hugo_cmd.Stdout = os.Stdout
+	hugo_cmd.Stderr = os.Stderr
+	err := hugo_cmd.Run()
+	if err != nil {
+		log.Fatal(err)
+	}
 	log.Infof("Hugo successfully built")
+	pagefind_cmd := exec.Command("pagefind", "--site", "web/public/", "--output-path", "web/static/pagefind/")
+	pagefind_cmd.Stdout = os.Stdout
+	pagefind_cmd.Stderr = os.Stderr
+	pagefind_err := pagefind_cmd.Run()
+	if pagefind_err != nil {
+		log.Fatal(pagefind_err)
+	}
+	log.Infof("Pagefind modules successfully built")
 	dConf := getDeploymentConfig()
 	DeploymenClient := connectDeployments3(dConf)
-	log.Infof("Connection to the bucket established")
-	test(DeploymenClient)
+	staticSiteUploader(DeploymenClient)
 
 }

markdown_writer.go

@@ -35,20 +35,30 @@ func markDownCreator() {
 
 		// Read XML file name
 		xmlFileName := filepath.Base(xmlFilePath)
+		log.Debug(xmlFilePath)
+		xmlContent, err := readXMLFile(xmlFilePath)
+		if err != nil {
+			log.Fatalf("Error reading the XML file %V", err)
+		}
+		headerValue, err := getHeaderValueFromXMLContent(xmlContent)
+		if err != nil {
+			log.Fatal("Error while getting header value from XML file", err)
+		}
 
+		log.Debugln("Header value: %V", headerValue)
 		// Remove file extension
 		fileNameWithoutExt := strings.TrimSuffix(xmlFileName, filepath.Ext(xmlFileName))
 
 		// Markdown content
-		markdownContent := fmt.Sprintf(`
----
+		markdownContent := fmt.Sprintf(`---
+title: "%s"
 ---
 
 {{< datafetch variable="%s" >}}
 
 
 Filename of the associated XML file: %s
-`, fileNameWithoutExt, xmlFileName)
+`, headerValue, fileNameWithoutExt, xmlFileName)
 
 		// Create Markdown file
 		mdFileName := filepath.Join(markdownDir, fileNameWithoutExt+".md")
@@ -66,12 +76,13 @@ Filename of the associated XML file: %s
 			return nil
 		}
 
-		log.Infoln("Markdown file %S created successfully!\n", mdFileName)
+		log.Debug("Markdown file %S created successfully!\n", mdFileName)
 
 		return nil
 	})
 
 	if err != nil {
 		log.Fatal("Error walking through directory:", err)
 	}
+
 }

static_files_uploader.go

@@ -14,7 +14,7 @@ import (
 	"github.com/aws/aws-sdk-go-v2/service/s3"
 )
 
-func test(DeploymenClient *DeploymentBackend) {
+func staticSiteUploader(DeploymenClient *DeploymentBackend) {
 	var (
 		localPath = "web/public/"
 		bucket    = DeploymenClient.Bucket
@@ -50,6 +50,9 @@ func test(DeploymenClient *DeploymentBackend) {
 		if ext == ".css" {
 			contentType = "text/css;"
 		}
+		if ext == ".svg" {
+			contentType = "image/svg+xml;"
+		}
 
 		if err != nil {
 			log.Fatalln("File bytes empty", path, err)
@@ -68,8 +71,10 @@ func test(DeploymenClient *DeploymentBackend) {
 		if err != nil {
 			log.Fatalln("Failed to upload", path, err)
 		}
-		log.Infoln("Uploaded", path, result.Location)
+		log.Debugln("Uploaded", path, result.Location)
 	}
+	log.Infoln("Successfully uploaded built static site to the bucket")
+
 }
 
 type fileWalk chan string

web/content/datasets/_index.md

@@ -1,5 +1,5 @@
 ---
-title: "Test"
+title: "Search"
 date: 2024-03-20T10:31:33+01:00
 layout: test
 ---

web/layouts/_default/baseof.html

@@ -2,17 +2,16 @@
 <html lang="{{ .Site.LanguageCode }}">
 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 
 {{ partial "head.html" . }}
-{{ partial "nav.html" . }}
+
+<body>
+    {{ partial "nav.html" . }}
 <!-- Page Header -->
-{{ block "header" .}}
 
 <header class="page-header" ,role="banner" >
                 <h1 class="project-name" >{{ .Site.Title}} </h1>
                 <h2 class="project-tagline">{{ .Site.Params.slogan }}</h2>
 </header>
-{{ end }}
-<body>
-<main id="content" class="main-content" role="main">
+    <main id="content" class="main-content" role="main">
 {{ block "main" . }}
 
 {{ end }}

web/layouts/datasets/list.html

@@ -1,11 +1,17 @@
 {{ define "main" }}
 <h2> Bigpicture Datasets</h2>
-<ul>
+
+<div id="search">
+<script>
+    window.addEventListener('DOMContentLoaded', (event) => {
+        new PagefindUI({ element: "#search", showSubResults: true });
+    });
+</script>
+<ul data-pagefind-ignore >
   {{ range .Pages }}
-      <a href="{{ .RelPermalink }}"><p>HUS mock dataset</p></a>
+      <a href="{{ .RelPermalink }}"><p>{{ .Params.title }}</p></a>
 
   {{ end }}
   </ul>
-{{ .Params.datasets.name }}
 {{ .Content }}
 {{ end }}

web/layouts/partials/head.html

@@ -19,6 +19,9 @@
     <link rel="canonical" href="{{ .RelPermalink }}">
 
     <link rel="stylesheet" href="{{ "css/style.css" | relURL }}">
+    <link rel="stylesheet" href="{{ "pagefind/pagefind-ui.css" | relURL}}" >
+
+<script src="{{ "pagefind/pagefind-ui.js" | relURL}}"></script>
 
     <!-- Custom Fonts -->
     <link href="https://cdn.jsdelivr.net/gh/FortAwesome/[email protected]/css/all.css" rel="stylesheet" type="text/css">

web/layouts/partials/nav.html

@@ -1,15 +1,31 @@
 
 
-        <div class="topnav">
+<div class="topnav" id="navbar">
 
-
-
-            <!-- Left-aligned links (default) -->
-
-            <a href="{{.Site.BaseURL}}">Home</a>
+            <script>
+var navbar = document.getElementById('navbar');
+  var navbarHeight = navbar.offsetHeight;
+  window.addEventListener('scroll', function() {
+    if (window.scrollY > 0) {
+      navbar.classList.add('shrink');
+    } else {
+      navbar.classList.remove('shrink');
+      navbar.style.position = 'initial';
+    }
+    if (window.scrollY >= navbarHeight) {
+      navbar.style.position = 'fixed';
+      navbar.style.top = '0';
+    } 
+  });
+</script> 
+
+<div class="logo-nav-container">
+<img id = "nav-logo" src="{{.Site.BaseURL}}/img/bigpicture_logo.svg"> 
+</div>     
+<div class="nav-links">
+            <a href="{{.Site.BaseURL}}/">Home</a>
             <a href="{{.Site.BaseURL}}/datasets.html">Datasets</a>
-
-
+          </div>
           </div>