+
+
package main
+
+import (
+ "flag"
+ "fmt"
+ "log"
+ "net/url"
+ "os"
+
+ "github.com/ilyakaznacheev/cleanenv"
+
+ "github.com/grafana/grafana-kiosk/pkg/initialize"
+ "github.com/grafana/grafana-kiosk/pkg/kiosk"
+)
+
+// Args command-line parameters
+type Args struct {
+ AutoFit bool
+ IgnoreCertificateErrors bool
+ IsPlayList bool
+ LXDEEnabled bool
+ LXDEHome string
+ ConfigPath string
+ Mode string
+ LoginMethod string
+ URL string
+ Username string
+ Password string
+}
+
+// ProcessArgs processes and handles CLI arguments
+func ProcessArgs(cfg interface{}) Args {
+ var a Args
+
+ f := flag.NewFlagSet("grafana-kiosk", flag.ContinueOnError)
+ f.StringVar(&a.ConfigPath, "c", "", "Path to configuration file (config.yaml)")
+ f.StringVar(&a.LoginMethod, "login-method", "anon", "[anon|local|gcom]")
+ f.StringVar(&a.Username, "username", "guest", "username")
+ f.StringVar(&a.Password, "password", "guest", "password")
+ f.StringVar(&a.Mode, "kiosk-mode", "full", "Kiosk Display Mode [full|tv|disabled]\nfull = No TOPNAV and No SIDEBAR\ntv = No SIDEBAR\ndisabled = omit option\n")
+ f.StringVar(&a.URL, "URL", "https://play.grafana.org", "URL to Grafana server")
+ f.BoolVar(&a.IsPlayList, "playlists", false, "URL is a playlist")
+ f.BoolVar(&a.AutoFit, "autofit", true, "Fit panels to screen")
+ f.BoolVar(&a.LXDEEnabled, "lxde", false, "Initialize LXDE for kiosk mode")
+ f.StringVar(&a.LXDEHome, "lxde-home", "/home/pi", "Path to home directory of LXDE user running X Server")
+ f.BoolVar(&a.IgnoreCertificateErrors, "ignore-certificate-errors", false, "Ignore SSL/TLS certificate error")
+
+ fu := f.Usage
+ f.Usage = func() {
+ fu()
+ envHelp, _ := cleanenv.GetDescription(cfg, nil)
+ fmt.Fprintln(f.Output())
+ fmt.Fprintln(f.Output(), envHelp)
+ }
+
+ err := f.Parse(os.Args[1:])
+ if err != nil {
+ os.Exit(-1)
+ }
+ return a
+}
+
+func setEnvironment() {
+ // for linux/X display must be set
+ var displayEnv = os.Getenv("DISPLAY")
+ if displayEnv == "" {
+ log.Println("DISPLAY not set, autosetting to :0.0")
+ os.Setenv("DISPLAY", ":0.0")
+ displayEnv = os.Getenv("DISPLAY")
+ }
+ log.Println("DISPLAY=", displayEnv)
+
+ var xAuthorityEnv = os.Getenv("XAUTHORITY")
+ if xAuthorityEnv == "" {
+ log.Println("XAUTHORITY not set, autosetting")
+ // use HOME of current user
+ var homeEnv = os.Getenv("HOME")
+ os.Setenv("XAUTHORITY", homeEnv+"/.Xauthority")
+ xAuthorityEnv = os.Getenv("XAUTHORITY")
+ }
+ log.Println("XAUTHORITY=", xAuthorityEnv)
+}
+
+func summary(cfg *kiosk.Config) {
+ // general
+ log.Println("AutoFit:", cfg.General.AutoFit)
+ log.Println("LXDEEnabled:", cfg.General.LXDEEnabled)
+ log.Println("LXDEHome:", cfg.General.LXDEHome)
+ log.Println("Mode:", cfg.General.Mode)
+ // target
+ log.Println("URL:", cfg.Target.URL)
+ log.Println("LoginMethod:", cfg.Target.LoginMethod)
+ log.Println("Username:", cfg.Target.Username)
+ log.Println("Password:", "*redacted*")
+ log.Println("IgnoreCertificateErrors:", cfg.Target.IgnoreCertificateErrors)
+ log.Println("IsPlayList:", cfg.Target.IsPlayList)
+}
+
+func main() {
+ var cfg kiosk.Config
+ // override
+ args := ProcessArgs(&cfg)
+ // check if config specified
+ if args.ConfigPath != "" {
+ // read configuration from the file and then override with environment variables
+ if err := cleanenv.ReadConfig(args.ConfigPath, &cfg); err != nil {
+ log.Println("Error reading config file", err)
+ os.Exit(-1)
+ } else {
+ log.Println("Using config from", args.ConfigPath)
+ }
+ } else {
+ log.Println("No config specified, using environment and args")
+ // no config, use environment and args
+ if err := cleanenv.ReadEnv(&cfg); err != nil {
+ log.Println("Error reading config from environment", err)
+ }
+ cfg.Target.URL = args.URL
+ cfg.Target.LoginMethod = args.LoginMethod
+ cfg.Target.Username = args.Username
+ cfg.Target.Password = args.Password
+ cfg.Target.IgnoreCertificateErrors = args.IgnoreCertificateErrors
+ cfg.Target.IsPlayList = args.IsPlayList
+ //
+ cfg.General.AutoFit = args.AutoFit
+ cfg.General.LXDEEnabled = args.LXDEEnabled
+ cfg.General.LXDEHome = args.LXDEHome
+ cfg.General.Mode = args.Mode
+ }
+ summary(&cfg)
+ // make sure the url has content
+ if cfg.Target.URL == "" {
+ os.Exit(1)
+ }
+ // validate url
+ _, err := url.ParseRequestURI(cfg.Target.URL)
+ if err != nil {
+ panic(err)
+ }
+ summary(&cfg)
+
+ if cfg.General.LXDEEnabled {
+ initialize.LXDE(cfg.General.LXDEHome)
+ }
+
+ // for linux/X display must be set
+ setEnvironment()
+ log.Println("method ", cfg.Target.LoginMethod)
+
+ switch cfg.Target.LoginMethod {
+ case "local":
+ log.Printf("Launching local login kiosk")
+ kiosk.GrafanaKioskLocal(&cfg)
+ case "gcom":
+ log.Printf("Launching GCOM login kiosk")
+ kiosk.GrafanaKioskGCOM(&cfg)
+ default:
+ log.Printf("Launching ANON login kiosk")
+ kiosk.GrafanaKioskAnonymous(&cfg)
+ }
+}
+
+
+
package initialize
+
+import (
+ "log"
+ "os"
+ "os/exec"
+)
+
+// LXDE runs shell commands to setup LXDE for kiosk mode
+func LXDE(path string) {
+ var command = "/usr/bin/lxpanel"
+
+ args := []string{"--profile", "LXDE"}
+ runCommand(path, command, args, true)
+ command = "/usr/bin/pcmanfm"
+ args = []string{"--desktop", "--profile", "LXDE"}
+ runCommand(path, command, args, true)
+ command = "/usr/bin/xset"
+ runCommand(path, command, args, true)
+ args = []string{"s", "off"}
+ runCommand(path, command, args, true)
+ args = []string{"-dpms"}
+ runCommand(path, command, args, true)
+ args = []string{"s", "noblank"}
+ runCommand(path, command, args, true)
+ command = "/usr/bin/unclutter"
+ displayEnv := os.Getenv("DISPLAY")
+ args = []string{"-display", displayEnv, "-idle", "5"}
+
+ go runCommand(path, command, args, true)
+}
+
+func runCommand(path string, command string, args []string, waitForEnd bool) {
+ // check if command exists
+ log.Printf("path: %v", path)
+ log.Printf("command: %v", command)
+ log.Printf("arg0: %v", args[0])
+ cmd := exec.Command(command, args...)
+ cmd.Env = append(os.Environ(),
+ "DISPLAY=:0.0",
+ "XAUTHORITY="+path+"/.Xauthority",
+ )
+ err := cmd.Start()
+ if err != nil {
+ //log.Printf(err)
+ log.Printf("Error in output, ignoring...")
+ }
+ if waitForEnd {
+ log.Printf("Waiting for command to finish...")
+ err = cmd.Wait()
+ if err != nil {
+ log.Printf("Command finished with error: %v", err)
+ }
+ }
+}
+
+
+
package kiosk
+
+import (
+ "context"
+ "io/ioutil"
+ "log"
+ "os"
+ "time"
+
+ "github.com/chromedp/chromedp"
+)
+
+// GrafanaKioskAnonymous creates a chrome-based kiosk using a local grafana-server account
+func GrafanaKioskAnonymous(cfg *Config) {
+ dir, err := ioutil.TempDir("", "chromedp-example")
+ if err != nil {
+ panic(err)
+ }
+ defer os.RemoveAll(dir)
+
+ opts := []chromedp.ExecAllocatorOption{
+ chromedp.NoFirstRun,
+ chromedp.NoDefaultBrowserCheck,
+ // chromedp.DisableGPU, // needed?
+ chromedp.Flag("noerrdialogs", true),
+ chromedp.Flag("kiosk", true),
+ chromedp.Flag("bwsi", true),
+ chromedp.Flag("incognito", true),
+ chromedp.Flag("disable-sync", true),
+ chromedp.Flag("disable-notifications", true),
+ chromedp.Flag("disable-overlay-scrollbar", true),
+ chromedp.Flag("ignore-certificate-errors", cfg.Target.IgnoreCertificateErrors),
+ chromedp.Flag("test-type", cfg.Target.IgnoreCertificateErrors),
+ chromedp.UserDataDir(dir),
+ }
+
+ allocCtx, cancel := chromedp.NewExecAllocator(context.Background(), opts...)
+ defer cancel()
+
+ // also set up a custom logger
+ taskCtx, cancel := chromedp.NewContext(allocCtx, chromedp.WithLogf(log.Printf))
+ defer cancel()
+
+ listenChromeEvents(taskCtx, consoleAPICall|targetCrashed)
+
+ // ensure that the browser process is started
+ if err := chromedp.Run(taskCtx); err != nil {
+ panic(err)
+ }
+
+ // Give browser time to load next page (this can be prone to failure, explore different options vs sleeping)
+ time.Sleep(2000 * time.Millisecond)
+
+ var generatedURL = GenerateURL(cfg.Target.URL, cfg.General.Mode, cfg.General.AutoFit, cfg.Target.IsPlayList)
+ log.Println("Navigating to ", generatedURL)
+ /*
+ Launch chrome and look for main-view element
+ */
+ if err := chromedp.Run(taskCtx,
+ chromedp.Navigate(generatedURL),
+ chromedp.WaitVisible(`//div[@class="main-view"]`, chromedp.BySearch),
+ // wait forever (for now)
+ chromedp.WaitVisible("notinputPassword", chromedp.ByID),
+ ); err != nil {
+ panic(err)
+ }
+ log.Println("Sleep before exit...")
+ // wait here for the process to exit
+ time.Sleep(2000 * time.Millisecond)
+ log.Println("Exit...")
+}
+
+
+
package kiosk
+
+import (
+ "context"
+ "io/ioutil"
+ "log"
+ "os"
+ "time"
+
+ "github.com/chromedp/chromedp"
+ "github.com/chromedp/chromedp/kb"
+)
+
+// GrafanaKioskGCOM creates a chrome-based kiosk using a grafana.com authenticated account
+func GrafanaKioskGCOM(cfg *Config) {
+ dir, err := ioutil.TempDir("", "chromedp-example")
+ if err != nil {
+ panic(err)
+ }
+ defer os.RemoveAll(dir)
+
+ opts := []chromedp.ExecAllocatorOption{
+ chromedp.NoFirstRun,
+ chromedp.NoDefaultBrowserCheck,
+ // chromedp.DisableGPU, // needed?
+ chromedp.Flag("noerrdialogs", true),
+ chromedp.Flag("kiosk", true),
+ chromedp.Flag("bwsi", true),
+ chromedp.Flag("incognito", true),
+ chromedp.Flag("disable-sync", true),
+ chromedp.Flag("disable-notifications", true),
+ chromedp.Flag("disable-overlay-scrollbar", true),
+ chromedp.UserDataDir(dir),
+ }
+
+ allocCtx, cancel := chromedp.NewExecAllocator(context.Background(), opts...)
+ defer cancel()
+
+ // also set up a custom logger
+ taskCtx, cancel := chromedp.NewContext(allocCtx, chromedp.WithLogf(log.Printf))
+ defer cancel()
+
+ listenChromeEvents(taskCtx, targetCrashed)
+
+ // ensure that the browser process is started
+ if err := chromedp.Run(taskCtx); err != nil {
+ panic(err)
+ }
+
+ var generatedURL = GenerateURL(cfg.Target.URL, cfg.General.Mode, cfg.General.AutoFit, cfg.Target.IsPlayList)
+ log.Println("Navigating to ", generatedURL)
+
+ /*
+ Launch chrome, click the grafana.com button, fill out login form and submit
+ */
+ // XPATH of grafana.com login button = //*[@href="login/grafana_com"]/i
+
+ // Click the grafana_com login button
+ if err := chromedp.Run(taskCtx,
+ chromedp.Navigate(generatedURL),
+ chromedp.WaitVisible(`//*[@href="login/grafana_com"]/i`, chromedp.BySearch),
+ chromedp.Click(`//*[@href="login/grafana_com"]/..`, chromedp.BySearch),
+ ); err != nil {
+ panic(err)
+ }
+ // Give browser time to load next page (this can be prone to failure, explore different options vs sleeping)
+ time.Sleep(2000 * time.Millisecond)
+ // Fill out grafana_com login page
+ if err := chromedp.Run(taskCtx,
+ chromedp.WaitVisible(`//input[@name="login"]`, chromedp.BySearch),
+ chromedp.SendKeys(`//input[@name="login"]`, cfg.Target.Username, chromedp.BySearch),
+ chromedp.SendKeys(`//input[@name="password"]`, cfg.Target.Password+kb.Enter, chromedp.BySearch),
+ chromedp.WaitVisible(`notinputPassword`, chromedp.ByID),
+ ); err != nil {
+ panic(err)
+ }
+}
+
+
+
package kiosk
+
+import (
+ "context"
+ "log"
+
+ "github.com/chromedp/cdproto/inspector"
+ "github.com/chromedp/cdproto/runtime"
+ "github.com/chromedp/chromedp"
+)
+
+type chromeEvents int
+
+const (
+ consoleAPICall chromeEvents = 1 << iota
+ targetCrashed
+)
+
+func listenChromeEvents(taskCtx context.Context, events chromeEvents) {
+ chromedp.ListenTarget(taskCtx, func(ev interface{}) {
+ switch ev := ev.(type) {
+ case *runtime.EventConsoleAPICalled:
+ if events&consoleAPICall != 0 {
+ log.Printf("console.%s call:\n", ev.Type)
+ for _, arg := range ev.Args {
+ log.Printf(" %s - %s\n", arg.Type, arg.Value)
+ }
+ }
+ case *inspector.EventTargetCrashed:
+ if events&targetCrashed != 0 {
+ log.Printf("target crashed, reload...")
+ go func() {
+ _ = chromedp.Run(taskCtx, chromedp.Reload())
+ }()
+ }
+ }
+ })
+}
+
+
+
package kiosk
+
+import (
+ "context"
+ "io/ioutil"
+ "log"
+ "os"
+ "time"
+
+ "github.com/chromedp/chromedp"
+ "github.com/chromedp/chromedp/kb"
+)
+
+// GrafanaKioskLocal creates a chrome-based kiosk using a local grafana-server account
+func GrafanaKioskLocal(cfg *Config) {
+ dir, err := ioutil.TempDir("", "chromedp-example")
+ if err != nil {
+ panic(err)
+ }
+ defer os.RemoveAll(dir)
+
+ opts := []chromedp.ExecAllocatorOption{
+ chromedp.NoFirstRun,
+ chromedp.NoDefaultBrowserCheck,
+ // chromedp.DisableGPU, // needed?
+ chromedp.Flag("noerrdialogs", true),
+ chromedp.Flag("kiosk", true),
+ chromedp.Flag("bwsi", true),
+ chromedp.Flag("incognito", true),
+ chromedp.Flag("disable-sync", true),
+ chromedp.Flag("disable-notifications", true),
+ chromedp.Flag("disable-overlay-scrollbar", true),
+ chromedp.Flag("ignore-certificate-errors", cfg.Target.IgnoreCertificateErrors),
+ chromedp.Flag("test-type", cfg.Target.IgnoreCertificateErrors),
+ chromedp.UserDataDir(dir),
+ }
+
+ allocCtx, cancel := chromedp.NewExecAllocator(context.Background(), opts...)
+ defer cancel()
+
+ // also set up a custom logger
+ taskCtx, cancel := chromedp.NewContext(allocCtx, chromedp.WithLogf(log.Printf))
+ defer cancel()
+
+ listenChromeEvents(taskCtx, targetCrashed)
+
+ // ensure that the browser process is started
+ if err := chromedp.Run(taskCtx); err != nil {
+ panic(err)
+ }
+
+ var generatedURL = GenerateURL(cfg.Target.URL, cfg.General.Mode, cfg.General.AutoFit, cfg.Target.IsPlayList)
+ log.Println("Navigating to ", generatedURL)
+ /*
+ Launch chrome and login with local user account
+
+ name=user, type=text
+ id=inputPassword, type=password, name=password
+ */
+ // Give browser time to load next page (this can be prone to failure, explore different options vs sleeping)
+ time.Sleep(2000 * time.Millisecond)
+
+ if err := chromedp.Run(taskCtx,
+ chromedp.Navigate(generatedURL),
+ chromedp.WaitVisible(`//input[@name="user"]`, chromedp.BySearch),
+ chromedp.SendKeys(`//input[@name="user"]`, cfg.Target.Username, chromedp.BySearch),
+ chromedp.SendKeys(`//input[@name="password"]`, cfg.Target.Password+kb.Enter, chromedp.BySearch),
+ chromedp.WaitVisible(`notinputPassword`, chromedp.ByID),
+ ); err != nil {
+ panic(err)
+ }
+}
+
+
+
package kiosk
+
+import (
+ "log"
+ "net/url"
+)
+
+// GenerateURL constructs URL with appropriate parameters for kiosk mode
+func GenerateURL(anURL string, kioskMode string, autoFit bool, isPlayList bool) string {
+ u, _ := url.ParseRequestURI(anURL)
+ q, _ := url.ParseQuery(u.RawQuery)
+
+ switch kioskMode {
+ case "tv": // TV
+ q.Set("kiosk", "tv") // no sidebar, topnav without buttons
+ log.Printf("KioskMode: TV")
+ case "full": // FULLSCREEN
+ q.Set("kiosk", "1") // sidebar and topnav always shown
+ log.Printf("KioskMode: Fullscreen")
+ case "disabled": // FULLSCREEN
+ log.Printf("KioskMode: Disabled")
+ default: // disabled
+ q.Set("kiosk", "1") // sidebar and topnav always shown
+ log.Printf("KioskMode: Fullscreen")
+ }
+ // a playlist should also go inactive immediately
+ if isPlayList {
+ q.Set("inactive", "1")
+ }
+ u.RawQuery = q.Encode()
+ if autoFit {
+ u.RawQuery += "&autofitpanels"
+ }
+ return u.String()
+}
+
+
+