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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
# A "setting" is a stored key/value pair. An "option" is a setting which has a default value and whose value
# can be changed on the options page.
#
# Option values which have never been changed by the user are in Settings.defaults.
#
# Settings whose values have been changed are:
# 1. stored either in chrome.storage.sync or in chrome.storage.local (but never both), and
# 2. cached in Settings.cache; on extension pages, Settings.cache uses localStorage (so it persists).
#
# In all cases except Settings.defaults, values are stored as jsonified strings.
# If the current frame is the Vomnibar or the HUD, then we'll need our Chrome stubs for the tests.
# We use "try" because this fails within iframes on Firefox (where failure doesn't actually matter).
try window.chrome ?= window.top?.chrome
storageArea = if chrome.storage.sync? then "sync" else "local"
Settings =
debug: false
storage: chrome.storage[storageArea]
cache: {}
isLoaded: false
onLoadedCallbacks: []
init: ->
if Utils.isExtensionPage() and Utils.isExtensionPage window.top
# On extension pages, we use localStorage (or a copy of it) as the cache.
# For UIComponents (or other content of ours in an iframe within a regular page), we can't access
# localStorage, so we check that the top level frame is also an extension page.
@cache = if Utils.isBackgroundPage() then localStorage else extend {}, localStorage
@runOnLoadedCallbacks()
# Test chrome.storage.sync to see if it is enabled.
# NOTE(mrmr1993, 2017-04-18): currently the API is defined in FF, but it is disabled behind a flag in
# about:config. Every use sets chrome.runtime.lastError, so we use that to check whether we can use it.
chrome.storage.sync.get null, =>
if chrome.runtime.lastError
storageArea = "local"
@storage = chrome.storage[storageArea]
# Delay this initialisation until after the correct storage area is known. The significance of this is
# that it delays the on-loaded callbacks.
chrome.storage.local.get null, (localItems) =>
localItems = {} if chrome.runtime.lastError
@storage.get null, (syncedItems) =>
unless chrome.runtime.lastError
@handleUpdateFromChromeStorage key, value for own key, value of extend localItems, syncedItems
chrome.storage.onChanged.addListener (changes, area) =>
@propagateChangesFromChromeStorage changes if area == storageArea
@runOnLoadedCallbacks()
# Called after @cache has been initialized. On extension pages, this will be called twice, but that does
# not matter because it's idempotent.
runOnLoadedCallbacks: ->
@log "runOnLoadedCallbacks: #{@onLoadedCallbacks.length} callback(s)"
@isLoaded = true
@onLoadedCallbacks.pop()() while 0 < @onLoadedCallbacks.length
onLoaded: (callback) ->
if @isLoaded then callback() else @onLoadedCallbacks.push callback
shouldSyncKey: (key) ->
(key of @defaults) and key not in [ "settingsVersion", "previousVersion" ]
propagateChangesFromChromeStorage: (changes) ->
@handleUpdateFromChromeStorage key, change?.newValue for own key, change of changes
handleUpdateFromChromeStorage: (key, value) ->
@log "handleUpdateFromChromeStorage: #{key}"
# Note: value here is either null or a JSONified string. Therefore, even falsy settings values (like
# false, 0 or "") are truthy here. Only null is falsy.
if @shouldSyncKey key
unless value and key of @cache and @cache[key] == value
value ?= JSON.stringify @defaults[key]
@set key, JSON.parse(value), false
get: (key) ->
console.log "WARNING: Settings have not loaded yet; using the default value for #{key}." unless @isLoaded
if key of @cache and @cache[key]? then JSON.parse @cache[key] else @defaults[key]
set: (key, value, shouldSetInSyncedStorage = true) ->
@cache[key] = JSON.stringify value
@log "set: #{key} (length=#{@cache[key].length}, shouldSetInSyncedStorage=#{shouldSetInSyncedStorage})"
if @shouldSyncKey key
if shouldSetInSyncedStorage
setting = {}; setting[key] = @cache[key]
@log " chrome.storage.#{storageArea}.set(#{key})"
@storage.set setting
if Utils.isBackgroundPage() and storageArea == "sync"
# Remove options installed by the "copyNonDefaultsToChromeStorage-20150717" migration; see below.
@log " chrome.storage.local.remove(#{key})"
chrome.storage.local.remove key
# NOTE(mrmr1993): In FF, |value| will be garbage collected when the page owning it is unloaded.
# Any postUpdateHooks that can be called from the options page/exclusions popup should be careful not to
# use |value| asynchronously, or else it may refer to a |DeadObject| and accesses will throw an error.
@performPostUpdateHook key, value
clear: (key) ->
@log "clear: #{key}"
@set key, @defaults[key]
has: (key) -> key of @cache
use: (key, callback) ->
@log "use: #{key} (isLoaded=#{@isLoaded})"
@onLoaded => callback @get key
# For settings which require action when their value changes, add hooks to this object.
postUpdateHooks: {}
performPostUpdateHook: (key, value) -> @postUpdateHooks[key]? value
# Completely remove a settings value, e.g. after migration to a new setting. This should probably only be
# called from the background page.
nuke: (key) ->
delete localStorage[key]
chrome.storage.local.remove key
chrome.storage.sync?.remove key
# For development only.
log: (args...) ->
console.log "settings:", args... if @debug
# Default values for all settings.
defaults:
scrollStepSize: 60
smoothScroll: true
keyMappings: "# Insert your preferred key mappings here."
linkHintCharacters: "sadfjklewcmpgh"
linkHintNumbers: "0123456789"
filterLinkHints: false
hideHud: false
userDefinedLinkHintCss:
"""
div > .vimiumHintMarker {
/* linkhint boxes */
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#FFF785),
color-stop(100%,#FFC542));
border: 1px solid #E3BE23;
}
div > .vimiumHintMarker span {
/* linkhint text */
color: black;
font-weight: bold;
font-size: 12px;
}
div > .vimiumHintMarker > .matchingCharacter {
}
"""
# Default exclusion rules.
exclusionRules:
[
# Disable Vimium on Gmail.
{ pattern: "https?://mail.google.com/*", passKeys: "" }
]
# NOTE: If a page contains both a single angle-bracket link and a double angle-bracket link, then in
# most cases the single bracket link will be "prev/next page" and the double bracket link will be
# "first/last page", so we put the single bracket first in the pattern string so that it gets searched
# for first.
# "\bprev\b,\bprevious\b,\bback\b,<,‹,←,«,≪,<<"
previousPatterns: "prev,previous,back,older,<,\u2039,\u2190,\xab,\u226a,<<"
# "\bnext\b,\bmore\b,>,›,→,»,≫,>>"
nextPatterns: "next,more,newer,>,\u203a,\u2192,\xbb,\u226b,>>"
# default/fall back search engine
searchUrl: "https://www.google.com/search?q="
# put in an example search engine
searchEngines:
"""
w: https://www.wikipedia.org/w/index.php?title=Special:Search&search=%s Wikipedia
# More examples.
#
# (Vimium supports search completion Wikipedia, as
# above, and for these.)
#
# g: https://www.google.com/search?q=%s Google
# l: https://www.google.com/search?q=%s&btnI I'm feeling lucky...
# y: https://www.youtube.com/results?search_query=%s Youtube
# gm: https://www.google.com/maps?q=%s Google maps
# b: https://www.bing.com/search?q=%s Bing
# d: https://duckduckgo.com/?q=%s DuckDuckGo
# az: https://www.amazon.com/s/?field-keywords=%s Amazon
# qw: https://www.qwant.com/?q=%s Qwant
"""
newTabUrl: "about:newtab"
grabBackFocus: false
regexFindMode: false
waitForEnterForFilteredHints: false # Note: this defaults to true for new users; see below.
settingsVersion: ""
helpDialog_showAdvancedCommands: false
optionsPage_showAdvancedOptions: false
passNextKeyKeys: []
ignoreKeyboardLayout: false
Settings.init()
# Perform migration from old settings versions, if this is the background page.
if Utils.isBackgroundPage()
Settings.applyMigrations = ->
unless Settings.get "settingsVersion"
# This is a new install. For some settings, we retain a legacy default behaviour for existing users but
# use a non-default behaviour for new users.
# For waitForEnterForFilteredHints, "true" gives a better UX; see #1950. However, forcing the change on
# existing users would be unnecessarily disruptive. So, only new users default to "true".
Settings.set "waitForEnterForFilteredHints", true
# We use settingsVersion to coordinate any necessary schema changes.
Settings.set("settingsVersion", Utils.getCurrentVersion())
# Remove legacy key which was used to control storage migration. This was after 1.57 (2016-10-01), and can
# be removed after 1.58 has been out for sufficiently long.
Settings.nuke "copyNonDefaultsToChromeStorage-20150717"
Settings.onLoaded Settings.applyMigrations.bind Settings
root = exports ? (window.root ?= {})
root.Settings = Settings
extend window, root unless exports?
|
