1 { unload } = require 'unload'
6 ADDON_ID = 'VimFx@akhodakivskiy.github.com'
8 { classes: Cc, interfaces: Ci, utils: Cu } = Components
10 HTMLInputElement = Ci.nsIDOMHTMLInputElement
11 HTMLTextAreaElement = Ci.nsIDOMHTMLTextAreaElement
12 HTMLSelectElement = Ci.nsIDOMHTMLSelectElement
13 XULMenuListElement = Ci.nsIDOMXULMenuListElement
14 XULDocument = Ci.nsIDOMXULDocument
15 XULElement = Ci.nsIDOMXULElement
16 XPathResult = Ci.nsIDOMXPathResult
17 HTMLDocument = Ci.nsIDOMHTMLDocument
18 HTMLElement = Ci.nsIDOMHTMLElement
19 Window = Ci.nsIDOMWindow
20 ChromeWindow = Ci.nsIDOMChromeWindow
22 _clip = Cc['@mozilla.org/widget/clipboard;1'].getService(Ci.nsIClipboard)
25 constructor: (@idFunc, @newFunc) ->
30 if container = @bucket[id]
33 return @bucket[id] = @newFunc(obj)
36 delete @bucket[id] if id = @idFunc(obj)
38 getEventWindow = (event) ->
39 if event.originalTarget instanceof Window
40 return event.originalTarget
42 doc = event.originalTarget.ownerDocument or event.originalTarget
43 if doc instanceof HTMLDocument or doc instanceof XULDocument
44 return doc.defaultView
46 getEventRootWindow = (event) ->
47 return unless window = getEventWindow(event)
48 return getRootWindow(window)
50 getEventCurrentTabWindow = (event) ->
51 return unless rootWindow = getEventRootWindow(event)
52 return getCurrentTabWindow(rootWindow)
54 getRootWindow = (window) ->
56 .QueryInterface(Ci.nsIInterfaceRequestor)
57 .getInterface(Ci.nsIWebNavigation)
58 .QueryInterface(Ci.nsIDocShellTreeItem)
60 .QueryInterface(Ci.nsIInterfaceRequestor)
63 getCurrentTabWindow = (window) ->
64 return window.gBrowser.selectedTab.linkedBrowser.contentWindow
66 blurActiveElement = (window) ->
67 # Only blur editable elements, in order not to interfere with the browser too much. TODO: Is that
68 # really needed? What if a website has made more elements focusable -- shouldn't those also be
70 { activeElement } = window.document
71 if activeElement and isElementEditable(activeElement)
74 isTextInputElement = (element) ->
75 return element instanceof HTMLInputElement or \
76 element instanceof HTMLTextAreaElement
78 isElementEditable = (element) ->
79 return element.isContentEditable or \
80 element instanceof HTMLInputElement or \
81 element instanceof HTMLTextAreaElement or \
82 element instanceof HTMLSelectElement or \
83 element instanceof XULMenuListElement or \
84 element.ownerDocument?.designMode?.toLowerCase() == 'on' or \
85 element.getAttribute?('g_editable') == 'true' or \
86 element.getAttribute?('contenteditable')?.toLowerCase() == 'true' or \
87 element.ownerDocument?.designMode?.toLowerCase() == 'on'
89 isElementVisible = (element) ->
90 document = element.ownerDocument
91 window = document.defaultView
92 if computedStyle = window.getComputedStyle(element, null)
93 return computedStyle.getPropertyValue('visibility') == 'visible' and \
94 computedStyle.getPropertyValue('display') != 'none' and \
95 computedStyle.getPropertyValue('opacity') != '0'
97 getWindowId = (window) ->
99 .QueryInterface(Components.interfaces.nsIInterfaceRequestor)
100 .getInterface(Components.interfaces.nsIDOMWindowUtils)
104 Cc['@mozilla.org/browser/sessionstore;1'].getService(Ci.nsISessionStore)
106 # Function that returns a URI to the css file that's part of the extension
109 baseURI = Services.io.newURI(__SCRIPT_URI_SPEC__, null, null)
110 uri = Services.io.newURI("resources/#{ name }.css", null, baseURI)
113 # Loads the css identified by the name in the StyleSheetService as User Stylesheet
114 # The stylesheet is then appended to every document, but it can be overwritten by
117 sss = Cc['@mozilla.org/content/style-sheet-service;1'].getService(Ci.nsIStyleSheetService)
120 # `AGENT_SHEET` is used to override userContent.css and Stylish. Custom website themes installed
121 # by users often make the hint markers unreadable, for example. Just using `!important` in the
123 if !sss.sheetRegistered(uri, sss.AGENT_SHEET)
124 sss.loadAndRegisterSheet(uri, sss.AGENT_SHEET)
127 sss.unregisterSheet(uri, sss.AGENT_SHEET)
129 # Simulate mouse click with full chain of event
130 # Copied from Vimium codebase
131 simulateClick = (element, modifiers = {}) ->
132 document = element.ownerDocument
133 window = document.defaultView
135 eventSequence = ['mouseover', 'mousedown', 'mouseup', 'click']
136 for event in eventSequence
137 mouseEvent = document.createEvent('MouseEvents')
138 mouseEvent.initMouseEvent(event, true, true, window, 1, 0, 0, 0, 0, modifiers.ctrlKey, false, false,
139 modifiers.metaKey, 0, null)
140 # Debugging note: Firefox will not execute the element's default action if we dispatch this click event,
141 # but Webkit will. Dispatching a click on an input box does not seem to focus it; we do that separately
142 element.dispatchEvent(mouseEvent)
144 WHEEL_MODE_PIXEL = Ci.nsIDOMWheelEvent.DOM_DELTA_PIXEL
145 WHEEL_MODE_LINE = Ci.nsIDOMWheelEvent.DOM_DELTA_LINE
146 WHEEL_MODE_PAGE = Ci.nsIDOMWheelEvent.DOM_DELTA_PAGE
148 # Simulate mouse scroll event by specific offsets given
149 # that mouse cursor is at specified position
150 simulateWheel = (window, deltaX, deltaY, mode = WHEEL_MODE_PIXEL) ->
152 .QueryInterface(Ci.nsIInterfaceRequestor)
153 .getInterface(Ci.nsIDOMWindowUtils)
155 [pX, pY] = [window.innerWidth / 2, window.innerHeight / 2]
156 windowUtils.sendWheelEvent(
157 pX, pY, # Window offset (x, y) in pixels
158 deltaX, deltaY, 0, # Deltas (x, y, z)
159 mode, # Mode (pixel, line, page)
161 0, 0, # Line or Page deltas (x, y)
165 # Write a string into system clipboard
166 writeToClipboard = (window, text) ->
167 str = Cc['@mozilla.org/supports-string;1'].createInstance(Ci.nsISupportsString)
170 trans = Cc['@mozilla.org/widget/transferable;1'].createInstance(Ci.nsITransferable)
173 privacyContext = window
174 .QueryInterface(Ci.nsIInterfaceRequestor)
175 .getInterface(Ci.nsIWebNavigation)
176 .QueryInterface(Ci.nsILoadContext)
177 trans.init(privacyContext)
179 trans.addDataFlavor('text/unicode')
180 trans.setTransferData('text/unicode', str, text.length * 2)
182 _clip.setData(trans, null, Ci.nsIClipboard.kGlobalClipboard)
184 # Read the system clipboard
185 readFromClipboard = (window) ->
186 trans = Cc['@mozilla.org/widget/transferable;1'].createInstance(Ci.nsITransferable)
189 privacyContext = window
190 .QueryInterface(Ci.nsIInterfaceRequestor)
191 .getInterface(Ci.nsIWebNavigation)
192 .QueryInterface(Ci.nsILoadContext)
193 trans.init(privacyContext)
195 trans.addDataFlavor('text/unicode')
197 clip = Cc['@mozilla.org/widget/clipboard;1'].getService(Ci.nsIClipboard)
198 clip.getData(trans, Ci.nsIClipboard.kGlobalClipboard)
203 trans.getTransferData('text/unicode', str, strLength)
206 str = str.value.QueryInterface(Ci.nsISupportsString)
207 return str.data.substring(0, strLength.value / 2)
211 # Executes function `func` and mearues how much time it took
212 timeIt = (func, msg) ->
213 start = new Date().getTime()
215 end = new Date().getTime()
217 console.log(msg, end - start)
220 isBlacklisted = (str) ->
221 matchingRules = getMatchingBlacklistRules(str)
222 return (matchingRules.length != 0)
224 # Returns all rules in the blacklist that match the provided string
225 getMatchingBlacklistRules = (str) ->
226 return getBlacklist().filter((rule) -> /// ^#{ simpleWildcards(rule) }$ ///i.test(str))
229 return splitListString(getPref('black_list'))
231 setBlacklist = (blacklist) ->
232 setPref('black_list', blacklist.join(','))
234 updateBlacklist = ({ add, remove } = {}) ->
235 blacklist = getBlacklist()
238 blacklist.push(splitListString(add)...)
240 blacklist = blacklist.filter((rule) -> rule != '')
241 blacklist = removeDuplicates(blacklist)
244 for rule in splitListString(remove) when rule in blacklist
245 blacklist.splice(blacklist.indexOf(rule), 1)
247 setBlacklist(blacklist)
249 # Splits a comma/space separated list into an array
250 splitListString = (str) ->
251 return str.split(/\s*,[\s,]*/)
253 # Prepares a string to be used in a regexp, where "*" matches zero or more characters
254 # and "!" matches one character.
255 simpleWildcards = (string) ->
256 return regexpEscape(string).replace(/\\\*/g, '.*').replace(/!/g, '.')
258 # Returns the first element that matches a pattern, favoring earlier patterns.
259 # The patterns are `simpleWildcards`s and must match either in the beginning or
260 # at the end of the text of the element. Moreover, a pattern does not match in
261 # the middle of words, so "previous" does not match "previously". If that is
262 # desired, a pattern such as "previous*" can be used instead.
263 # Note: We cannot use `\b` word boundaries, because they don’t work well with
264 # non-English characters. Instead we match a space as word boundary. Therefore
265 # we normalize the whitespace and add spaces at the edges of the element text.
266 getBestPatternMatch = (patterns, elements) ->
267 for pattern in patterns
268 wildcarded = simpleWildcards(pattern)
269 regexp = /// ^\s(?:#{ wildcarded })\s | \s(?:#{ wildcarded })\s$ ///i
270 for element in elements
271 text = " #{ element.textContent } ".replace(/\s+/g, ' ')
277 # Gets VimFx verions. AddonManager only provides async API to access addon data, so it's a bit tricky...
283 Cu.import('resource://gre/modules/AddonManager.jsm', scope)
284 scope.AddonManager.getAddonByID(ADDON_ID, (addon) -> version = addon.version)
289 parseHTML = (document, html) ->
290 parser = Cc['@mozilla.org/parserutils;1'].getService(Ci.nsIParserUtils)
291 flags = parser.SanitizerAllowStyle
292 return parser.parseFragment(html, flags, false, null, document.documentElement)
294 createElement = (document, type, attributes = {}) ->
295 element = document.createElement(type)
297 for attribute, value of attributes
298 element.setAttribute(attribute, value)
300 if document instanceof HTMLDocument
301 element.classList.add('VimFxReset')
305 # Uses nsIIOService to parse a string as a URL and find out if it is a URL
308 url = Cc['@mozilla.org/network/io-service;1']
309 .getService(Ci.nsIIOService)
310 .newURI(str, null, null)
311 .QueryInterface(Ci.nsIURL)
316 # Use Firefox services to search for a given string
317 browserSearchSubmission = (str) ->
318 ss = Cc['@mozilla.org/browser/search-service;1']
319 .getService(Ci.nsIBrowserSearchService)
321 engine = ss.currentEngine or ss.defaultEngine
322 return engine.getSubmission(str, null)
324 # Get hint characters, convert them to lower case, and filter duplicates
326 hintChars = getPref('hint_chars')
327 # Make sure that hint chars contain at least two characters
328 if hintChars.length < 2
331 return removeDuplicateCharacters(hintChars)
333 # Remove duplicate characters from string (case insensitive)
334 removeDuplicateCharacters = (str) ->
335 return removeDuplicates( str.toLowerCase().split('') ).join('')
337 # Return URI to some file in the extension packaged as resource
338 getResourceURI = do ->
339 baseURI = Services.io.newURI(__SCRIPT_URI_SPEC__, null, null)
340 return (path) -> return Services.io.newURI(path, null, baseURI)
342 # Escape string to render it usable in regular expressions
343 regexpEscape = (s) -> s and s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&')
345 removeDuplicates = (array) ->
347 return array.filter((item) -> if seen[item] then false else (seen[item] = true))
349 ACTION_ELEMENT_TAGS = [
355 ACTION_ELEMENT_PROPERTIES = [
362 "contains(@class, 'button')"
363 "contains(@class, 'js-new-tweets-bar')"
366 EDITABLE_ELEMENT_TAGS = [
369 "input[not(@type='hidden' or @disabled)]"
372 EDITABLE_ELEMENT_PROPERTIES = [
373 "@contenteditable=''"
374 "translate(@contenteditable, 'TRUE', 'true')='true'"
377 FOCUSABLE_ELEMENT_TAGS = [
383 FOCUSABLE_ELEMENT_PROPERTIES = [
387 getMarkableElements = do ->
388 xpathify = (tags, properties)->
390 .concat("*[#{ properties.join(' or ') }]")
391 .map((rule) -> "//#{ rule } | //xhtml:#{ rule }")
395 action: xpathify(ACTION_ELEMENT_TAGS, ACTION_ELEMENT_PROPERTIES )
396 editable: xpathify(EDITABLE_ELEMENT_TAGS, EDITABLE_ELEMENT_PROPERTIES )
397 focusable: xpathify(FOCUSABLE_ELEMENT_TAGS, FOCUSABLE_ELEMENT_PROPERTIES)
399 [ACTION_ELEMENT_TAGS..., EDITABLE_ELEMENT_TAGS..., FOCUSABLE_ELEMENT_TAGS... ],
400 [ACTION_ELEMENT_PROPERTIES..., EDITABLE_ELEMENT_PROPERTIES..., FOCUSABLE_ELEMENT_PROPERTIES...]
403 namespaceResolver = (namespace) ->
404 if namespace == 'xhtml' then 'http://www.w3.org/1999/xhtml' else null
406 # The actual function that will return the desired elements
407 return (document, { type }, resultType = XPathResult.ORDERED_NODE_SNAPSHOT_TYPE) ->
408 result = document.evaluate(xpaths[type], document.documentElement, namespaceResolver, resultType, null)
409 return (result.snapshotItem(i) for i in [0...result.snapshotLength] by 1)
412 exports.Bucket = Bucket
413 exports.getEventWindow = getEventWindow
414 exports.getEventRootWindow = getEventRootWindow
415 exports.getEventCurrentTabWindow = getEventCurrentTabWindow
416 exports.getRootWindow = getRootWindow
417 exports.getCurrentTabWindow = getCurrentTabWindow
419 exports.getWindowId = getWindowId
420 exports.blurActiveElement = blurActiveElement
421 exports.isTextInputElement = isTextInputElement
422 exports.isElementEditable = isElementEditable
423 exports.isElementVisible = isElementVisible
424 exports.getSessionStore = getSessionStore
426 exports.loadCss = loadCss
428 exports.simulateClick = simulateClick
429 exports.simulateWheel = simulateWheel
430 exports.WHEEL_MODE_PIXEL = WHEEL_MODE_PIXEL
431 exports.WHEEL_MODE_LINE = WHEEL_MODE_LINE
432 exports.WHEEL_MODE_PAGE = WHEEL_MODE_PAGE
433 exports.readFromClipboard = readFromClipboard
434 exports.writeToClipboard = writeToClipboard
435 exports.timeIt = timeIt
437 exports.getMatchingBlacklistRules = getMatchingBlacklistRules
438 exports.isBlacklisted = isBlacklisted
439 exports.updateBlacklist = updateBlacklist
440 exports.splitListString = splitListString
441 exports.getBestPatternMatch = getBestPatternMatch
443 exports.getVersion = getVersion
444 exports.parseHTML = parseHTML
445 exports.createElement = createElement
446 exports.isURL = isURL
447 exports.browserSearchSubmission = browserSearchSubmission
448 exports.getHintChars = getHintChars
449 exports.removeDuplicates = removeDuplicates
450 exports.removeDuplicateCharacters = removeDuplicateCharacters
451 exports.getResourceURI = getResourceURI
452 exports.getMarkableElements = getMarkableElements
453 exports.ADDON_ID = ADDON_ID