Merge pull request #3 from merlinfuchs/multi-page

Support multiple pages with different layouts

Author: merlinfuchs

README.md

@@ -23,47 +23,82 @@ blimp
 
 ## Configuration
 
-The app will look for a configuration file called `blimp.toml`. Here is an example configuration for the example above:
+The app will look for a configuration file called `blimp.toml`. Blimp comes with pretty good defaults but you can adjust everything how you want.
 
-```toml
-# The layout is based on a grid, you can add rows and columns or remove some widgets
-# On smaller screens you probably don't want to cramp everything in, so remove the views that you don't need
-layout = [
-    ["weather", "weather"],
-    ["weather", "weather"],
-    ["feeds", "feeds"],
-    ["latency", "status"]
-]
+### Configure the widgets
 
-[[views.status.targets]]
+```toml
+[[widgets.status.targets]]
 name = "Xenon Bot"
 type = "https"
 host = "xenon.bot"
 
-[[views.status.targets]]
+[[widgets.status.targets]]
 name = "Embed Generator"
 type = "https"
 host = "message.style"
 
-[[views.status.targets]]
+[[widgets.status.targets]]
 name = "Friendly Captcha API"
 type = "https"
 host = "eu-api.friendlycaptcha.eu"
 
-[[views.status.targets]]
+[[widgets.status.targets]]
 name = "Google DNS"
 type = "ping"
 host = "8.8.8.8"
 
-[views.weather]
+[widgets.weather]
 # You openweathermap.org API key
 owm_api_key = ""
 # The latitude and longitude of the weather location
 owm_lat = 51.33
 owm_lon = 12.37
 
-[[views.feeds.targets]]
+[[widgets.feeds.targets]]
 url = "https://hnrss.org/newest"
 ```
 
+## Configure the layout
+
+Blimp supports multiple pages that it switches between on an interval. Each page can have a distinct grid layout with different widgets. If you don't want blimp to switch between pages, only define one page.
+
+```toml
+# How fast do you want blimp to switch between pages
+page_interval = 30000 # 30 seconds is the default
+
+# Your first page
+[[pages]]
+layout = [
+    ["weather", "weather"],
+    ["weather", "weather"],
+    ["feeds", "feeds"],
+    ["latency", "status"]
+]
+
+# Your second page
+[[pages]]
+layout = [
+    ["feeds", "feeds"],
+    ["feeds", "feeds"],
+    ["feeds", "feeds"],
+    ["latency", "status"]
+]
+
+# Your third page
+[[pages]]
+...
+```
+
 Look at the [default config](internal/config/default.config.toml) for other values you can override.
+
+## Logging
+
+Because logging to STDOUT is pointless because STDOUT is already used for the UI output, you can find log messages in a file called `blimp.log`.
+
+If you want blimp to write to a different logfile you can set it in the config like this:
+
+```toml
+[logging]
+filename = "blimp.log"
+```

internal/app.go

@@ -0,0 +1,154 @@
+package internal
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/gdamore/tcell/v2"
+	"github.com/merlinfuchs/blimp/internal/config"
+	"github.com/merlinfuchs/blimp/internal/widgets/feeds"
+	"github.com/merlinfuchs/blimp/internal/widgets/latency"
+	"github.com/merlinfuchs/blimp/internal/widgets/status"
+	"github.com/merlinfuchs/blimp/internal/widgets/weather"
+	"github.com/rivo/tview"
+)
+
+func AppEntry() error {
+	app := tview.NewApplication()
+
+	widgets := map[string]Widget{
+		"latency": latency.New(),
+		"status":  status.New(),
+		"weather": weather.New(),
+		"feeds":   feeds.New(),
+	}
+
+	pages, err := parsePagesFromConfig()
+	if err != nil {
+		return fmt.Errorf("failed to parse pages: %w", err)
+	}
+
+	if len(pages) == 0 {
+		return fmt.Errorf("no pages defined")
+	}
+
+	pagesView, err := constructPages(pages, widgets)
+	if err != nil {
+		return fmt.Errorf("failed to construct pages: %w", err)
+	}
+	currentPage := 0
+
+	frame := tview.NewFrame(pagesView).
+		SetBorders(2, 2, 1, 0, 4, 4)
+
+	go func() {
+		for {
+			frame.Clear()
+
+			now := time.Now()
+			frame.
+				AddText("Blimp v0.1.0", true, tview.AlignLeft, tcell.ColorDimGray).
+				AddText(now.Format("15:04:05"), true, tview.AlignCenter, tcell.ColorLightGray).
+				AddText(now.Format("Monday, January 2, 2006"), true, tview.AlignCenter, tcell.ColorDimGray).
+				AddText(pages[currentPage].Title, true, tview.AlignRight, tcell.ColorDimGray)
+
+			app.QueueUpdateDraw(func() {
+				for _, widget := range widgets {
+					widget.Update()
+				}
+			})
+
+			<-time.After(time.Duration(config.K.Int("update_interval")) * time.Millisecond)
+		}
+	}()
+
+	go func() {
+		for {
+			<-time.After(time.Duration(config.K.Int("page_interval")) * time.Millisecond)
+			currentPage = (currentPage + 1) % len(pages)
+			pagesView.SwitchToPage(fmt.Sprintf("%d", currentPage))
+		}
+	}()
+
+	defer func() {
+		for _, widget := range widgets {
+			widget.Stop()
+		}
+	}()
+
+	if err := app.SetRoot(frame, true).EnableMouse(false).Run(); err != nil {
+		return fmt.Errorf("failed to run app: %w", err)
+	}
+
+	return nil
+}
+
+func constructPages(pages []Page, widgets map[string]Widget) (*tview.Pages, error) {
+	view := tview.NewPages()
+
+	usedWidgets := make(map[string]bool, len(widgets))
+
+	for i, page := range pages {
+		if len(page.Layout) == 0 {
+			return nil, fmt.Errorf("page #%d (%s) has no layout", i, page.Title)
+		}
+
+		rowValues := make([]int, len(page.Layout))
+		for i := 0; i < len(rowValues); i++ {
+			rowValues[i] = -1
+		}
+
+		colValues := make([]int, len(page.Layout[0]))
+		for i := 0; i < len(colValues); i++ {
+			colValues[i] = -1
+		}
+
+		grid := tview.NewGrid().
+			SetGap(1, 2).
+			SetRows(rowValues...).
+			SetColumns(colValues...)
+
+		for widgetName, widget := range widgets {
+			found := false
+
+			minRow := -1
+			maxRow := -1
+			minCol := -1
+			maxCol := -1
+
+			for r, cols := range page.Layout {
+				for c, name := range cols {
+					if name == widgetName {
+						found = true
+						maxRow = r
+						maxCol = c
+						if minRow == -1 {
+							minRow = r
+						}
+						if minCol == -1 {
+							minCol = c
+						}
+					}
+				}
+			}
+
+			if found {
+				rowSpan := maxRow - minRow + 1
+				colSpan := maxCol - minCol + 1
+
+				usedWidgets[widgetName] = true
+				grid.AddItem(widget.Primitive(), minRow, minCol, rowSpan, colSpan, 0, 0, false)
+			}
+		}
+
+		view.AddPage(fmt.Sprintf("%d", i), grid, true, i == 0)
+	}
+
+	for widgetName, widget := range widgets {
+		if usedWidgets[widgetName] {
+			widget.Start()
+		}
+	}
+
+	return view, nil
+}

internal/config/default.config.toml

@@ -1,27 +1,42 @@
-update_interval = 250
+update_interval = 250 # 250 ms
+page_interval = 30000 # 30 seconds
 
+[[pages]]
 layout = [
     ["weather", "weather"],
     ["weather", "weather"],
     ["feeds", "feeds"],
     ["latency", "status"]
 ]
 
-[views.latency]
+[[pages]]
+layout = [
+    ["feeds", "feeds"],
+    ["feeds", "feeds"],
+    ["latency", "status"]
+]
+
+[widgets.latency]
 update_interval = 500 # 0.5 seconds
 history_length = 25
 target_host = "www.google.com"
 
-[views.status]
+[widgets.status]
 update_interval = 10000 # 10 seconds
 
-[views.weather]
+[widgets.weather]
 update_interval = 600000 # 10 minutes
 owm_language = "en"
 owm_unit = "metric"
 
-[views.feeds]
+[widgets.feeds]
 update_interval = 60000 # 1 minutes
 max_items = 0 # 0 means auto
 show_feed_title = true
-show_published_time = true
+show_published_time = true
+
+[logging]
+filename = "blimp.log"
+max_size = 1 # in MB
+max_age = 7 # in days
+max_backups = 5 # // note: old ones will still be deleted after max_age

internal/page.go

@@ -0,0 +1,18 @@
+package internal
+
+import "github.com/merlinfuchs/blimp/internal/config"
+
+type Page struct {
+	Title  string     `koanf:"title"`
+	Layout [][]string `koanf:"layout"`
+}
+
+func parsePagesFromConfig() ([]Page, error) {
+	var pages []Page
+
+	if err := config.K.Unmarshal("pages", &pages); err != nil {
+		return nil, err
+	}
+
+	return pages, nil
+}

internal/view.go internal/widget.gointernal/view.go renamed to internal/widget.go

@@ -2,7 +2,7 @@ package internal
 
 import "github.com/rivo/tview"
 
-type View interface {
+type Widget interface {
 	Start()
 	Stop()
 	Update() error

internal/views/feeds/feeds.go internal/widgets/feeds/feeds.gointernal/views/feeds/feeds.go renamed to internal/widgets/feeds/feeds.go

@@ -23,7 +23,7 @@ type FeedsView struct {
 
 func New() *FeedsView {
 	targets := make([]FeedTarget, 0)
-	if err := config.K.Unmarshal("views.feeds.targets", &targets); err != nil {
+	if err := config.K.Unmarshal("widgets.feeds.targets", &targets); err != nil {
 		log.Panic().Err(err).Msgf("Failed to unmarshal status targets")
 	}
 
@@ -49,7 +49,7 @@ func (l *FeedsView) Start() {
 			select {
 			case <-l.stopped:
 				return
-			case <-time.After(time.Duration(config.K.Int("views.feeds.update_interval")) * time.Millisecond):
+			case <-time.After(time.Duration(config.K.Int("widgets.feeds.update_interval")) * time.Millisecond):
 				l.updateItems()
 			}
 		}
@@ -99,7 +99,7 @@ func (l *FeedsView) Update() error {
 	l.view.Clear()
 
 	items := l.items
-	maxItems := config.K.Int("views.feeds.max_items")
+	maxItems := config.K.Int("widgets.feeds.max_items")
 	if maxItems == 0 {
 		_, _, _, height := l.view.GetRect()
 		maxItems = height - 4
@@ -111,14 +111,14 @@ func (l *FeedsView) Update() error {
 
 	for _, item := range items {
 		text := "[gray]-"
-		if config.K.Bool("views.feeds.show_published_time") {
+		if config.K.Bool("widgets.feeds.show_published_time") {
 			published := item.Item.PublishedParsed
 			if published != nil {
 				text += fmt.Sprintf(" [yellowgreen]%s", published.Format("2006-01-02 15:04"))
 			}
 		}
 
-		if config.K.Bool("views.feeds.show_feed_title") {
+		if config.K.Bool("widgets.feeds.show_feed_title") {
 			text += fmt.Sprintf(" [gray]%s", item.Feed.Title)
 		}