#55: Remove href links from markdown template

Author: vdjagilev

formatter/formatter_md.go

@@ -3,6 +3,7 @@ package formatter
 import (
 	// Used in this place to have all required functionality within one binary file. No need for separate folders/files, just embed template
 	_ "embed"
+	"fmt"
 	"html/template"
 	"strings"
 )
@@ -30,27 +31,42 @@ func (f *MarkdownFormatter) Format(td *TemplateData) (err error) {
 func (f *MarkdownFormatter) defineTemplateFunctions(tmpl *template.Template) {
 	tmpl.Funcs(
 		template.FuncMap{
-			"md_toc": markdownTOCEntry,
-			"md":     markdownEntry,
-			"noesc":  markdownNoEscape,
+			"md_toc":   markdownTOCEntry,
+			"md":       markdownEntry,
+			"noesc":    markdownNoEscape,
+			"md_title": markdownHostAnchorTitle,
+			"md_link":  markdownAnchorLink,
 		},
 	)
 }
 
+// markdownHostAnchorTitle helps to generate a title for specific hostname
+func markdownHostAnchorTitle(h *Host) string {
+	title := h.HostAddress.Address
+	for i := range h.HostNames.HostName {
+		title += fmt.Sprintf(" / %s", h.HostNames.HostName[i].Name)
+	}
+	title += fmt.Sprintf(" (%s)", h.Status.State)
+	return title
+}
+
+// markdownAnchorLink is converting generated anchor title to table-of-contents entry
+func markdownAnchorLink(h *Host) string {
+	return markdownTOCEntry(markdownHostAnchorTitle(h))
+}
+
+// markdownTOCEntry returns lower-cased Table-of-Contents
+// anchor entry that should work as an internal link
 func markdownTOCEntry(v string) string {
-	// Removing dots, replacing spaces with hyphens,
-	// then convert it to lower-case
-	return strings.ToLower(
-		strings.ReplaceAll(
-			strings.ReplaceAll(
-				v,
-				".",
-				"",
-			),
-			" ",
-			"-",
-		),
+	r := strings.NewReplacer(
+		".", "",
+		" ", "-",
+		"/", "",
+		"(", "",
+		")", "",
 	)
+	// replace special characters and lower-case
+	return strings.ToLower(r.Replace(v))
 }
 
 func markdownEntry(v string) string {

formatter/formatter_md_test.go

@@ -100,6 +100,13 @@ func Test_markdownTOCEntry(t *testing.T) {
 			},
 			want: "19216822-test-host",
 		},
+		{
+			name: "IP addr with brackets and slashes",
+			args: args{
+				v: "192.168.2.2 / example.com (up)",
+			},
+			want: "19216822--examplecom-up",
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
@@ -442,3 +449,95 @@ func TestMarkdownFormatter_Format(t *testing.T) {
 		})
 	}
 }
+
+func Test_markdownHostAnchorTitle(t *testing.T) {
+	type args struct {
+		h *Host
+	}
+	tests := []struct {
+		name string
+		args args
+		want string
+	}{
+		{
+			name: "IP addr (up)",
+			args: args{
+				h: &Host{
+					HostAddress: HostAddress{
+						Address: "192.168.1.21",
+					},
+					Status: HostStatus{
+						State: "up",
+					},
+				},
+			},
+			want: "192.168.1.21 (up)",
+		},
+		{
+			name: "IP addr (down)",
+			args: args{
+				h: &Host{
+					HostAddress: HostAddress{
+						Address: "192.168.22.23",
+					},
+					Status: HostStatus{
+						State: "down",
+					},
+				},
+			},
+			want: "192.168.22.23 (down)",
+		},
+		{
+			name: "IP addr, 1 hostname (up)",
+			args: args{
+				h: &Host{
+					HostAddress: HostAddress{
+						Address: "192.168.22.23",
+					},
+					HostNames: HostNames{
+						[]HostName{
+							{
+								Name: "example.com",
+							},
+						},
+					},
+					Status: HostStatus{
+						State: "up",
+					},
+				},
+			},
+			want: "192.168.22.23 / example.com (up)",
+		},
+		{
+			name: "IP addr, 2 hostnames (up)",
+			args: args{
+				h: &Host{
+					HostAddress: HostAddress{
+						Address: "192.168.32.33",
+					},
+					HostNames: HostNames{
+						[]HostName{
+							{
+								Name: "example.com",
+							},
+							{
+								Name: "example2.com",
+							},
+						},
+					},
+					Status: HostStatus{
+						State: "up",
+					},
+				},
+			},
+			want: "192.168.32.33 / example.com / example2.com (up)",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := markdownHostAnchorTitle(tt.args.h); got != tt.want {
+				t.Errorf("markdownHostAnchorTitle() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

formatter/resources/templates/markdown.tmpl

@@ -11,14 +11,7 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 {{- end }}{{/* if $skipSummary */}}
 {{- range .NMAPRun.Host -}}
 {{- if or ($displayDownHosts) (eq .Status.State "up") }}
-* [{{ .HostAddress.Address }}{{ range .HostNames.HostName }} / {{ .Name }}{{ end }} ({{ .Status.State }})](#{{ md_toc .HostAddress.Address }})
-{{- if eq .Status.State "up" }}
-	* [Info](#{{ md_toc .HostAddress.Address }}-info)
-	* [Ports](#{{ md_toc .HostAddress.Address }}-ports)
-	{{- if not $skipPortScripts }}
-	* [Scripts](#{{ md_toc .HostAddress.Address }}-scripts)
-	{{- end -}}{{/* if not $skipPortScripts */}}
-{{- end }}
+* [{{ md_title . }}](#{{ md_link . }})
 {{- end -}}{{/* if or ($displayDownHosts) (eq .Status.State "up") */}}
 {{- end -}}{{/* range .Host */}}
 
@@ -48,13 +41,10 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 
 {{ range .NMAPRun.Host -}}
 {{- if or ($displayDownHosts) (eq .Status.State "up") }}
-<a id="{{ md_toc .HostAddress.Address }}"></a>
 
-## {{ .HostAddress.Address }}{{ range .HostNames.HostName }} / {{ .Name }}{{ end }}{{ if eq .Status.State "up" }} (up){{ else }} (down){{ end }}
+## {{ md_title . }}
 
 {{- if eq .Status.State "up" }}
-<a id="{{ md_toc .HostAddress.Address }}-info"></a>
-
 ### Info:
 
 | Name | Value |
@@ -72,8 +62,6 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 {{- end -}}{{/* if .OS.OSMatch.Name */}}
 {{ end }}{{/* if .OS */}}
 
-<a id="{{ md_toc .HostAddress.Address }}-ports"></a>
-
 ### Ports:
 
 | Port | State | Service | Reason | Product | Version | Extra Info |
@@ -82,7 +70,6 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 | {{ .PortID }} | {{ .Protocol }} | {{ .State.State }} | {{ .Service.Name }} | {{ .State.Reason }} | {{ .Service.Product }} | {{ .Service.Version }} | {{ .Service.ExtraInfo }} |
 {{ end }}{{/* range .Ports.Port */}}
 {{ if not $skipPortScripts }}
-<a id="{{ md_toc .HostAddress.Address }}-scripts"></a>
 
 ### Scripts:
 {{ range .Ports.Port -}}