/
options.coffee
326 lines (270 loc) · 12 KB
/
options.coffee
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
$ = (id) -> document.getElementById id
bgExclusions = chrome.extension.getBackgroundPage().Exclusions
# We have to use Settings from the background page here (not Settings, directly) to avoid a race condition for
# the page popup. Specifically, we must ensure that the settings have been updated on the background page
# *before* the popup closes. This ensures that any exclusion-rule changes are in place before the page
# regains the focus.
bgSettings = chrome.extension.getBackgroundPage().Settings
#
# Class hierarchy for various types of option.
class Option
# Base class for all option classes.
# Abstract. Option does not define @populateElement or @readValueFromElement.
# Static. Array of all options.
@all = []
constructor: (@field,@onUpdated) ->
@element = $(@field)
@element.addEventListener "change", @onUpdated
@fetch()
Option.all.push this
# Fetch a setting from localStorage, remember the @previous value and populate the DOM element.
# Return the fetched value.
fetch: ->
@populateElement @previous = bgSettings.get @field
@previous
# Write this option's new value back to localStorage, if necessary.
save: ->
value = @readValueFromElement()
if JSON.stringify(value) != JSON.stringify @previous
bgSettings.set @field, @previous = value
restoreToDefault: ->
bgSettings.clear @field
@fetch()
# Static method.
@saveOptions: ->
Option.all.map (option) -> option.save()
# Abstract method; only implemented in sub-classes.
# Populate the option's DOM element (@element) with the setting's current value.
# populateElement: (value) -> DO_SOMETHING
# Abstract method; only implemented in sub-classes.
# Extract the setting's new value from the option's DOM element (@element).
# readValueFromElement: -> RETURN_SOMETHING
class NumberOption extends Option
populateElement: (value) -> @element.value = value
readValueFromElement: -> parseFloat @element.value
class TextOption extends Option
constructor: (args...) ->
super(args...)
@element.addEventListener "input", @onUpdated
populateElement: (value) -> @element.value = value
readValueFromElement: -> @element.value.trim()
class NonEmptyTextOption extends Option
constructor: (args...) ->
super(args...)
@element.addEventListener "input", @onUpdated
populateElement: (value) -> @element.value = value
# If the new value is not empty, then return it. Otherwise, restore the default value.
readValueFromElement: -> if value = @element.value.trim() then value else @restoreToDefault()
class CheckBoxOption extends Option
populateElement: (value) -> @element.checked = value
readValueFromElement: -> @element.checked
class ExclusionRulesOption extends Option
constructor: (args...) ->
super(args...)
$("exclusionAddButton").addEventListener "click", (event) =>
@addRule()
# Add a new rule, focus its pattern, scroll it into view, and return the newly-added element. On the
# options page, there is no current URL, so there is no initial pattern. This is the default. On the popup
# page (see ExclusionRulesOnPopupOption), the pattern is pre-populated based on the current tab's URL.
addRule: (pattern="") ->
element = @appendRule { pattern: pattern, passKeys: "" }
@getPattern(element).focus()
exclusionScrollBox = $("exclusionScrollBox")
exclusionScrollBox.scrollTop = exclusionScrollBox.scrollHeight
@onUpdated()
element
populateElement: (rules) ->
for rule in rules
@appendRule rule
# Append a row for a new rule. Return the newly-added element.
appendRule: (rule) ->
content = document.querySelector('#exclusionRuleTemplate').content
row = document.importNode content, true
for field in ["pattern", "passKeys"]
element = row.querySelector ".#{field}"
element.value = rule[field]
for event in [ "input", "change" ]
element.addEventListener event, @onUpdated
@getRemoveButton(row).addEventListener "click", (event) =>
rule = event.target.parentNode.parentNode
rule.parentNode.removeChild rule
@onUpdated()
@element.appendChild row
@element.children[@element.children.length-1]
readValueFromElement: ->
rules =
for element in @element.getElementsByClassName "exclusionRuleTemplateInstance"
pattern: @getPattern(element).value.trim()
passKeys: @getPassKeys(element).value.trim()
rules.filter (rule) -> rule.pattern
# Accessors for the three main sub-elements of an "exclusionRuleTemplateInstance".
getPattern: (element) -> element.querySelector(".pattern")
getPassKeys: (element) -> element.querySelector(".passKeys")
getRemoveButton: (element) -> element.querySelector(".exclusionRemoveButton")
# ExclusionRulesOnPopupOption is ExclusionRulesOption, extended with some UI tweeks suitable for use in the
# page popup. This also differs from ExclusionRulesOption in that, on the page popup, there is always a URL
# (@url) associated with the current tab.
class ExclusionRulesOnPopupOption extends ExclusionRulesOption
constructor: (@url, args...) ->
super(args...)
addRule: ->
element = super @generateDefaultPattern()
@activatePatternWatcher element
# ExclusionRulesOption.addRule()/super() has focused the pattern. Here, focus the passKeys instead;
# because, in the popup, we already have a pattern, so the user is more likely to edit the passKeys.
@getPassKeys(element).focus()
# Return element (for consistency with ExclusionRulesOption.addRule()).
element
populateElement: (rules) ->
super(rules)
elements = @element.getElementsByClassName "exclusionRuleTemplateInstance"
@activatePatternWatcher element for element in elements
haveMatch = false
for element in elements
pattern = @getPattern(element).value.trim()
if 0 <= @url.search bgExclusions.RegexpCache.get pattern
haveMatch = true
@getPassKeys(element).focus()
else
element.style.display = 'none'
@addRule() unless haveMatch
# Provide visual feedback (make it red) when a pattern does not match the current tab's URL.
activatePatternWatcher: (element) ->
patternElement = element.children[0].firstChild
patternElement.addEventListener "keyup", =>
if @url.match bgExclusions.RegexpCache.get patternElement.value
patternElement.title = patternElement.style.color = ""
else
patternElement.style.color = "red"
patternElement.title = "Red text means that the pattern does not\nmatch the current URL."
# Generate a default exclusion-rule pattern from a URL. This is then used to pre-populate the pattern on
# the page popup.
generateDefaultPattern: ->
if /^https?:\/\/./.test @url
# The common use case is to disable Vimium at the domain level.
# Generate "https?://www.example.com/*" from "http://www.example.com/path/to/page.html".
"https?:/" + @url.split("/",3)[1..].join("/") + "/*"
else if /^[a-z]{3,}:\/\/./.test @url
# Anything else which seems to be a URL.
@url.split("/",3).join("/") + "/*"
else
@url + "*"
Options =
exclusionRules: ExclusionRulesOption
filterLinkHints: CheckBoxOption
waitForEnterForFilteredHints: CheckBoxOption
hideHud: CheckBoxOption
keyMappings: TextOption
linkHintCharacters: NonEmptyTextOption
linkHintNumbers: NonEmptyTextOption
newTabUrl: NonEmptyTextOption
nextPatterns: NonEmptyTextOption
previousPatterns: NonEmptyTextOption
regexFindMode: CheckBoxOption
scrollStepSize: NumberOption
smoothScroll: CheckBoxOption
grabBackFocus: CheckBoxOption
searchEngines: TextOption
searchUrl: NonEmptyTextOption
userDefinedLinkHintCss: TextOption
initOptionsPage = ->
onUpdated = ->
$("saveOptions").removeAttribute "disabled"
$("saveOptions").innerHTML = "Save Changes"
# Display either "linkHintNumbers" or "linkHintCharacters", depending upon "filterLinkHints".
maintainLinkHintsView = ->
hide = (el) -> el.style.display = "none"
show = (el) -> el.style.display = "table-row"
if $("filterLinkHints").checked
hide $("linkHintCharactersContainer")
show $("linkHintNumbersContainer")
show $("waitForEnterForFilteredHintsContainer")
else
show $("linkHintCharactersContainer")
hide $("linkHintNumbersContainer")
hide $("waitForEnterForFilteredHintsContainer")
maintainAdvancedOptions = ->
if bgSettings.get "optionsPage_showAdvancedOptions"
$("advancedOptions").style.display = "table-row-group"
$("advancedOptionsButton").innerHTML = "Hide Advanced Options"
else
$("advancedOptions").style.display = "none"
$("advancedOptionsButton").innerHTML = "Show Advanced Options"
maintainAdvancedOptions()
toggleAdvancedOptions = (event) ->
bgSettings.set "optionsPage_showAdvancedOptions", not bgSettings.get "optionsPage_showAdvancedOptions"
maintainAdvancedOptions()
$("advancedOptionsButton").blur()
event.preventDefault()
activateHelpDialog = ->
HelpDialog.toggle showAllCommandDetails: true
saveOptions = ->
$("linkHintCharacters").value = $("linkHintCharacters").value.toLowerCase()
Option.saveOptions()
$("saveOptions").disabled = true
$("saveOptions").innerHTML = "No Changes"
$("saveOptions").addEventListener "click", saveOptions
$("advancedOptionsButton").addEventListener "click", toggleAdvancedOptions
$("showCommands").addEventListener "click", activateHelpDialog
$("filterLinkHints").addEventListener "click", maintainLinkHintsView
for element in document.getElementsByClassName "nonEmptyTextOption"
element.className = element.className + " example info"
element.innerHTML = "Leave empty to reset this option."
window.onbeforeunload = -> "You have unsaved changes to options." unless $("saveOptions").disabled
document.addEventListener "keyup", (event) ->
if event.ctrlKey and event.keyCode == 13
document.activeElement.blur() if document?.activeElement?.blur
saveOptions()
# Populate options. The constructor adds each new object to "Option.all".
for own name, type of Options
new type(name,onUpdated)
maintainLinkHintsView()
initPopupPage = ->
chrome.tabs.query { active: true, currentWindow: true }, ([tab]) ->
exclusions = null
document.getElementById("optionsLink").setAttribute "href", chrome.runtime.getURL("pages/options.html")
# As the active URL, we choose the most recently registered URL from a frame in the tab, or the tab's own
# URL.
url = chrome.extension.getBackgroundPage().urlForTab[tab.id] || tab.url
updateState = ->
rule = bgExclusions.getRule url, exclusions.readValueFromElement()
$("state").innerHTML = "Vimium will " +
if rule and rule.passKeys
"exclude <span class='code'>#{rule.passKeys}</span>"
else if rule
"be disabled"
else
"be enabled"
onUpdated = ->
$("helpText").innerHTML = "Type <strong>Ctrl-Enter</strong> to save and close."
$("saveOptions").removeAttribute "disabled"
$("saveOptions").innerHTML = "Save Changes"
updateState() if exclusions
saveOptions = ->
Option.saveOptions()
$("saveOptions").innerHTML = "Saved"
$("saveOptions").disabled = true
$("saveOptions").addEventListener "click", saveOptions
document.addEventListener "keyup", (event) ->
if event.ctrlKey and event.keyCode == 13
saveOptions()
window.close()
# Populate options. Just one, here.
exclusions = new ExclusionRulesOnPopupOption url, "exclusionRules", onUpdated
updateState()
document.addEventListener "keyup", updateState
#
# Initialization.
document.addEventListener "DOMContentLoaded", ->
xhr = new XMLHttpRequest()
xhr.open 'GET', chrome.extension.getURL('pages/exclusions.html'), true
xhr.onreadystatechange = ->
if xhr.readyState == 4
$("exclusionScrollBox").innerHTML = xhr.responseText
switch location.pathname
when "/pages/options.html" then initOptionsPage()
when "/pages/popup.html" then initPopupPage()
xhr.send()
# Exported for tests.
root = exports ? window
extend root, {Options, isVimiumOptionsPage: true}