summaryrefslogtreecommitdiffstats
path: root/interfacer/src/browsh/config.go
blob: 9e72755940e1fc4fb88db79e98917fd810ce5ae5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
package browsh

import (
	"bytes"
	"fmt"
	"os"
	"path/filepath"
	"strings"

	"github.com/shibukawa/configdir"
	"github.com/spf13/pflag"
	"github.com/spf13/viper"
)

var (
	configFilename = "config.toml"

	isDebug   = pflag.Bool("debug", false, "Log to ./debug.log")
	timeLimit = pflag.Int("time-limit", 0, "Kill Browsh after the specified number of seconds")
	_         = pflag.Bool("http-server-mode", false, "Run as an HTTP service")

	_ = pflag.String("startup-url", "https://www.brow.sh", "URL to launch at startup")
	_ = pflag.String("firefox.path", "firefox", "Path to Firefox executable")
	_ = pflag.Bool("firefox.with-gui", false, "Don't use headless Firefox")
	_ = pflag.Bool("firefox.use-existing", false, "Whether Browsh should launch Firefox or not")
	_ = pflag.Bool("monochrome", false, "Start browsh in monochrome mode")
)

func getConfigNamespace() string {
	if IsTesting {
		return "browsh-testing"
	}
	return "browsh"
}

// Gets a cross-platform path to a folder containing Browsh config
func getConfigDir() string {
	marker := "browsh-settings"
	// configdir has no other option but to have a nested folder
	configDirs := configdir.New(getConfigNamespace(), marker)
	folders := configDirs.QueryFolders(configdir.Global)
	// Delete the previously enforced nested folder
	path := strings.Trim(folders[0].Path, marker)
	os.MkdirAll(path, os.ModePerm)
	ensureConfigFile(path)
	return path
}

// Copy the sample config file if the user doesn't already have a config file
func ensureConfigFile(path string) {
	fullPath := filepath.Join(path, configFilename)
	if _, err := os.Stat(fullPath); os.IsNotExist(err) {
		file, err := os.Create(fullPath)
		if err != nil {
			Shutdown(err)
		}
		defer file.Close()
		_, err = file.WriteString(configSample)
		if err != nil {
			Shutdown(err)
		}
	}
}

// Gets a cross-platform path to store a Browsh-specific Firefox profile
func getFirefoxProfilePath() string {
	configDirs := configdir.New(getConfigNamespace(), "firefox_profile")
	folders := configDirs.QueryFolders(configdir.Global)
	folders[0].MkdirAll()
	return folders[0].Path
}

func setDefaults() {
	// Temporary experimental configurable keybindings
	viper.SetDefault("tty.keys.next-tab", []string{"\u001c", "28", "2"})

	// Vim commands
	vimKeyMap["normal gg"] = "scrollToTop"
	vimKeyMap["normal G"] = "scrollToBottom"
	vimKeyMap["normal j"] = "scrollDown"
	vimKeyMap["normal k"] = "scrollUp"
	vimKeyMap["normal h"] = "scrollLeft"
	vimKeyMap["normal l"] = "scrollRight"
	vimKeyMap["normal d"] = "scrollHalfPageDown"
	vimKeyMap["normal <C-d>"] = "scrollHalfPageDown"
	vimKeyMap["normal u"] = "scrollHalfPageUp"
	vimKeyMap["normal <C-u>"] = "scrollHalfPageUp"
	vimKeyMap["normal e"] = "editURL"
	vimKeyMap["normal ge"] = "editURL"
	vimKeyMap["normal gE"] = "editURLInNewTab"
	vimKeyMap["normal H"] = "historyBack"
	vimKeyMap["normal L"] = "historyForward"
	vimKeyMap["normal J"] = "prevTab"
	vimKeyMap["normal K"] = "nextTab"
	vimKeyMap["normal r"] = "reload"
	vimKeyMap["normal xx"] = "removeTab"
	vimKeyMap["normal X"] = "restoreTab"
	vimKeyMap["normal t"] = "newTab"
	vimKeyMap["normal T"] = "searchForTab"
	vimKeyMap["normal /"] = "findMode"
	vimKeyMap["normal n"] = "findNext"
	vimKeyMap["normal N"] = "findPrevious"
	vimKeyMap["normal g0"] = "firstTab"
	vimKeyMap["normal g$"] = "lastTab"
	vimKeyMap["normal gu"] = "urlUp"
	vimKeyMap["normal gU"] = "urlRoot"
	vimKeyMap["normal <<"] = "moveTabLeft"
	vimKeyMap["normal >>"] = "moveTabRight"
	vimKeyMap["normal ^"] = "previouslyVisitedTab"
	vimKeyMap["normal m"] = "makeMark"
	vimKeyMap["normal '"] = "gotoMark"
	vimKeyMap["normal i"] = "insertMode"
	vimKeyMap["normal I"] = "insertModeHard"
	vimKeyMap["normal yy"] = "copyURL"
	vimKeyMap["normal p"] = "openClipboardURL"
	vimKeyMap["normal P"] = "openClipboardURLInNewTab"
	vimKeyMap["normal gi"] = "focusFirstTextInput"
	vimKeyMap["normal f"] = "openLinkInCurrentTab"
	vimKeyMap["normal F"] = "openLinkInNewTab"
	vimKeyMap["normal <M-f>"] = "openMultipleLinksInNewTab"
	vimKeyMap["normal yf"] = "copyLinkURL"
	vimKeyMap["normal [["] = "followLinkLabeledPrevious"
	vimKeyMap["normal ]]"] = "followLinkLabeledNext"
	vimKeyMap["normal yt"] = "duplicateTab"
	vimKeyMap["normal v"] = "visualMode"
	vimKeyMap["normal ?"] = "viewHelp"
	vimKeyMap["caret v"] = "visualMode"
	vimKeyMap["caret h"] = "moveCaretLeft"
	vimKeyMap["caret l"] = "moveCaretRight"
	vimKeyMap["caret j"] = "moveCaretDown"
	vimKeyMap["caret k"] = "moveCaretUp"
	vimKeyMap["caret <Enter>"] = "clickAtCaretPosition"
	vimKeyMap["visual c"] = "caretMode"
	vimKeyMap["visual o"] = "swapVisualModeCursorPosition"
	vimKeyMap["visual y"] = "copyVisualModeSelection"
}

func loadConfig() {
	dir := getConfigDir()
	fullPath := filepath.Join(dir, configFilename)
	Log("Looking in " + fullPath + " for config.")
	viper.SetConfigType("toml")
	viper.SetConfigName(strings.Trim(configFilename, ".toml"))
	viper.AddConfigPath(dir)
	viper.AddConfigPath(".")
	setDefaults()
	// First load the sample config in case the user hasn't updated any new fields
	err := viper.ReadConfig(bytes.NewBuffer([]byte(configSample)))
	if err != nil {
		panic(fmt.Errorf("Config file error: %s \n", err))
	}
	// Then load the users own config file, overwriting the sample config
	err = viper.MergeInConfig()
	if err != nil {
		panic(fmt.Errorf("Config file error: %s \n", err))
	}
	viper.BindPFlags(pflag.CommandLine)
}