Categories

brzaguza_example.yaml

@@ -1,21 +1,19 @@
-engines:
-  bing:
-    enabled: false
-  brave:
-    enabled: false
-  duckduckgo:
-    enabled: false
-  etools:
-    enabled: false
-  google:
-    enabled: false
-  mojeek:
-    enabled: false
-  qwant:
-    enabled: false
-  startpage:
-    enabled: false
-  swisscows:
-    enabled: false
-  yep:
-    enabled: false
+categories:
+  science:
+    engines:
+      startpage:
+        enabled: true
+      duckduckgo:
+        enabled: false
+    ranking:
+      engines:
+        mojeek:
+          mul: 1
+  general:
+    engines:
+      google:
+        enabled: true
+
+server:
+  cache:
+    type: none

src/category/category.go

@@ -0,0 +1,32 @@
+package category
+
+import (
+	"strings"
+)
+
+var FromString map[string]Name = map[string]Name{
+	//main
+	"general": GENERAL,
+	"info":    INFO,
+	"science": SCIENCE,
+	"news":    NEWS,
+	"blog":    BLOG,
+	"surf":    SURF,
+	"newnews": NEWNEWS,
+	//alternatives
+	"wiki":  INFO,
+	"sci":   SCIENCE,
+	"nnews": NEWNEWS,
+}
+
+// returns category
+func FromQuery(query string) Name {
+	if query[0] != '!' {
+		return ""
+	}
+	cat := strings.SplitN(query, " ", 2)[0][1:]
+	if val, ok := FromString[cat]; ok {
+		return val
+	}
+	return ""
+}

src/category/name.go

@@ -0,0 +1,15 @@
+package category
+
+type Name string
+
+// enumer not necessary, won't be updated often, have to have ShortcutMap anyways
+const (
+	UNDEFINED Name = "undefined"
+	GENERAL   Name = "general"
+	INFO      Name = "info"
+	SCIENCE   Name = "science"
+	NEWS      Name = "news"
+	BLOG      Name = "blog"
+	SURF      Name = "surf"
+	NEWNEWS   Name = "newnews"
+)

src/cli/climode.go

@@ -7,6 +7,7 @@ import (
 	"github.com/rs/zerolog/log"
 	"github.com/tminaorg/brzaguza/src/bucket/result"
 	"github.com/tminaorg/brzaguza/src/cache"
+	"github.com/tminaorg/brzaguza/src/category"
 	"github.com/tminaorg/brzaguza/src/config"
 	"github.com/tminaorg/brzaguza/src/engines"
 	"github.com/tminaorg/brzaguza/src/search"
@@ -17,7 +18,7 @@ func printResults(results []result.Result) {
 	for _, r := range results {
 		fmt.Printf("%v (%.2f) -----\n\t\"%v\"\n\t\"%v\"\n\t\"%v\"\n\t-", r.Rank, r.Score, r.Title, r.URL, r.Description)
 		for seInd := uint8(0); seInd < r.TimesReturned; seInd++ {
-			fmt.Printf("%v", r.EngineRanks[seInd].SearchEngine)
+			fmt.Printf("%v", r.EngineRanks[seInd].SearchEngine.ToLower())
 			if seInd != r.TimesReturned-1 {
 				fmt.Print(", ")
 			}
@@ -36,7 +37,7 @@ func Run(flags Flags, db cache.DB, conf *config.Config) {
 	options := engines.Options{
 		MaxPages:   flags.MaxPages,
 		VisitPages: flags.Visit,
-		Category:   flags.Category,
+		Category:   category.FromString[flags.Category],
 	}
 
 	start := time.Now()

src/cli/structs.go

@@ -18,7 +18,7 @@ type Flags struct {
 	Config    string `type:"path" default:"${config_path}" env:"BRZAGUZA_CONFIG" help:"Config folder path"`
 	Log       string `type:"path" default:"${log_path}" env:"BRZAGUZA_LOG" help:"Log file path"`
 	Verbosity int8   `type:"counter" default:"0" short:"v" env:"BRZAGUZA_VERBOSITY" help:"Log level verbosity"`
-	Category  string `type:"string" default:"" short:"c" env:"BRZAGUZA_CATEGORY" help:"Search result category. Can also be supplied through the query (e.g. \"!info smartphone\"). Supported values: info[/wiki], science[/sci], news, blog, surf, new news[/nnews]"`
+	Category  string `type:"string" default:"" short:"c" env:"BRZAGUZA_CATEGORY" help:"Search result category. Can also be supplied through the query (e.g. \"!info smartphone\"). Supported values: info[/wiki], science[/sci], news, blog, surf, newnews[/nnews]"`
 	// profiler
 	CPUProfile    bool `type:"bool" default:"false" env:"BRZAGUZA_CPUPROFILE" help:"Use cpu profiling"`
 	HeapProfile   bool `type:"bool" default:"false" env:"BRZAGUZA_HEAPPROFILE" help:"Use heap profiling"`

src/config/defaults.go

@@ -1,6 +1,9 @@
 package config
 
-import "github.com/tminaorg/brzaguza/src/engines"
+import (
+	"github.com/tminaorg/brzaguza/src/category"
+	"github.com/tminaorg/brzaguza/src/engines"
+)
 
 const DefaultLocale string = "en-US"
 
@@ -16,62 +19,128 @@ func NewRanking() Ranking {
 		TRC:  1,
 		TRD:  0,
 		Engines: map[string]EngineRanking{
-			engines.Bing.ToLower(): {
+			engines.BING.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Brave.ToLower(): {
+			engines.BRAVE.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.DuckDuckGo.ToLower(): {
+			engines.DUCKDUCKGO.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Etools.ToLower(): {
+			engines.ETOOLS.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Google.ToLower(): {
+			engines.GOOGLE.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Mojeek.ToLower(): {
+			engines.MOJEEK.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Presearch.ToLower(): {
+			engines.PRESEARCH.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Qwant.ToLower(): {
+			engines.QWANT.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Startpage.ToLower(): {
+			engines.STARTPAGE.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Swisscows.ToLower(): {
+			engines.SWISSCOWS.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Yahoo.ToLower(): {
+			engines.YAHOO.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Yandex.ToLower(): {
+			engines.YANDEX.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
-			engines.Yep.ToLower(): {
+			engines.YEP.ToLower(): {
 				Mul:   1,
 				Const: 0,
 			},
 		},
 	}
 }
 
+func NewSettings() map[engines.Name]Settings {
+	return map[engines.Name]Settings{
+		engines.BING: {
+			Shortcut: "bi",
+		},
+		engines.BRAVE: {
+			Shortcut: "br",
+		},
+		engines.DUCKDUCKGO: {
+			Shortcut: "ddg",
+		},
+		engines.ETOOLS: {
+			Shortcut: "ets",
+		},
+		engines.GOOGLE: {
+			Shortcut: "go",
+		},
+		engines.MOJEEK: {
+			Shortcut: "mjk",
+		},
+		engines.PRESEARCH: {
+			Shortcut: "ps",
+		},
+		engines.QWANT: {
+			Shortcut: "qw",
+		},
+		engines.STARTPAGE: {
+			Shortcut: "sp",
+		},
+		engines.SWISSCOWS: {
+			Shortcut: "sc",
+		},
+		engines.YAHOO: {
+			Shortcut: "yh",
+		},
+		engines.YEP: {
+			Shortcut: "yep",
+		},
+	}
+}
+
+func NewAllEnabled() []engines.Name {
+	return []engines.Name{
+		engines.BING,
+		engines.BRAVE,
+		engines.DUCKDUCKGO,
+		engines.ETOOLS,
+		engines.GOOGLE,
+		engines.MOJEEK,
+		engines.PRESEARCH,
+		engines.QWANT,
+		engines.STARTPAGE,
+		engines.SWISSCOWS,
+		engines.YAHOO,
+		engines.YEP,
+	}
+}
+
+func NewInfo() []engines.Name {
+	return []engines.Name{
+		engines.BING,
+		engines.GOOGLE,
+		engines.MOJEEK,
+	}
+}
+
 func New() *Config {
 	return &Config{
 		Server: Server{
@@ -85,68 +154,36 @@ func New() *Config {
 				},
 			},
 		},
-		Engines: map[string]Engine{
-			engines.Bing.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "bi",
-				},
+		Settings: NewSettings(),
+		Categories: map[category.Name]Category{
+			category.GENERAL: {
+				Engines: NewAllEnabled(),
+				Ranking: NewRanking(),
 			},
-			engines.Brave.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "br",
-				},
+			category.INFO: {
+				Engines: NewInfo(),
+				Ranking: NewRanking(),
 			},
-			engines.DuckDuckGo.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "ddg",
-				},
+			category.SCIENCE: {
+				Engines: NewAllEnabled(),
+				Ranking: NewRanking(),
 			},
-			engines.Etools.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "ets",
-				},
+			category.NEWS: {
+				Engines: NewAllEnabled(),
+				Ranking: NewRanking(),
 			},
-			engines.Google.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "go",
-				},
+			category.BLOG: {
+				Engines: NewAllEnabled(),
+				Ranking: NewRanking(),
 			},
-			engines.Mojeek.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "mjk",
-				},
-			},
-			engines.Qwant.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "qw",
-				},
-			},
-			engines.Startpage.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "sp",
-				},
-			},
-			engines.Swisscows.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "sc",
-				},
+			category.SURF: {
+				Engines: NewAllEnabled(),
+				Ranking: NewRanking(),
 			},
-			engines.Yep.ToLower(): {
-				Enabled: true,
-				Settings: Settings{
-					Shortcut: "yep",
-				},
+			category.NEWNEWS: {
+				Engines: NewAllEnabled(),
+				Ranking: NewRanking(),
 			},
 		},
-		Ranking: NewRanking(),
 	}
 }