]>
Commit | Line | Data |
---|---|---|
2207d356 | 1 | /** |
55cb43d7 | 2 | * @license MIT |
2207d356 | 3 | */ |
55cb43d7 | 4 | |
6198556e | 5 | import { LinkMatcherOptions } from './Interfaces'; |
7ac4f1a9 | 6 | import { LinkMatcher, LinkMatcherHandler, LinkMatcherValidationCallback } from './Types'; |
6198556e DI |
7 | |
8 | const INVALID_LINK_CLASS = 'xterm-invalid-link'; | |
2207d356 | 9 | |
2207d356 DI |
10 | const protocolClause = '(https?:\\/\\/)'; |
11 | const domainCharacterSet = '[\\da-z\\.-]+'; | |
12 | const negatedDomainCharacterSet = '[^\\da-z\\.-]+'; | |
13 | const domainBodyClause = '(' + domainCharacterSet + ')'; | |
14 | const tldClause = '([a-z\\.]{2,6})'; | |
15 | const ipClause = '((\\d{1,3}\\.){3}\\d{1,3})'; | |
28d4ec77 | 16 | const localHostClause = '(localhost)'; |
2207d356 | 17 | const portClause = '(:\\d{1,5})'; |
28d4ec77 | 18 | const hostClause = '((' + domainBodyClause + '\\.' + tldClause + ')|' + ipClause + '|' + localHostClause + ')' + portClause + '?'; |
7279ee0f | 19 | const pathClause = '(\\/[\\/\\w\\.\\-%]*)*'; |
ccadf3fc | 20 | const queryStringHashFragmentCharacterSet = '[0-9\\w\\[\\]\\(\\)\\/\\?\\!#@$%&\'*+,:;\\=\\.\\-]*'; |
9aae4396 DI |
21 | const queryStringClause = '(\\?' + queryStringHashFragmentCharacterSet + ')?'; |
22 | const hashFragmentClause = '(#' + queryStringHashFragmentCharacterSet + ')?'; | |
7279ee0f | 23 | const negatedPathCharacterSet = '[^\\/\\w\\.\\-%]+'; |
9aae4396 | 24 | const bodyClause = hostClause + pathClause + queryStringClause + hashFragmentClause; |
2207d356 DI |
25 | const start = '(?:^|' + negatedDomainCharacterSet + ')('; |
26 | const end = ')($|' + negatedPathCharacterSet + ')'; | |
f7bc0fba | 27 | const strictUrlRegex = new RegExp(start + protocolClause + bodyClause + end); |
2207d356 | 28 | |
55cb43d7 DI |
29 | /** |
30 | * The ID of the built in http(s) link matcher. | |
31 | */ | |
7167b06b DI |
32 | const HYPERTEXT_LINK_MATCHER_ID = 0; |
33 | ||
f7bc0fba DI |
34 | /** |
35 | * The Linkifier applies links to rows shortly after they have been refreshed. | |
36 | */ | |
2207d356 | 37 | export class Linkifier { |
15d79143 DI |
38 | /** |
39 | * The time to wait after a row is changed before it is linkified. This prevents | |
40 | * the costly operation of searching every row multiple times, pntentially a | |
41 | * huge aount of times. | |
42 | */ | |
43 | protected static TIME_BEFORE_LINKIFY = 200; | |
44 | ||
7ac4f1a9 DI |
45 | protected _linkMatchers: LinkMatcher[]; |
46 | ||
26ebc3d9 | 47 | private _document: Document; |
2207d356 DI |
48 | private _rows: HTMLElement[]; |
49 | private _rowTimeoutIds: number[]; | |
5183332f | 50 | private _nextLinkMatcherId = HYPERTEXT_LINK_MATCHER_ID; |
2207d356 | 51 | |
26ebc3d9 DI |
52 | constructor(document: Document, rows: HTMLElement[]) { |
53 | this._document = document; | |
2207d356 DI |
54 | this._rows = rows; |
55 | this._rowTimeoutIds = []; | |
7167b06b | 56 | this._linkMatchers = []; |
c8bb3216 | 57 | this.registerLinkMatcher(strictUrlRegex, null, 1); |
2207d356 DI |
58 | } |
59 | ||
60 | /** | |
61 | * Queues a row for linkification. | |
62 | * @param {number} rowIndex The index of the row to linkify. | |
63 | */ | |
64 | public linkifyRow(rowIndex: number): void { | |
65 | const timeoutId = this._rowTimeoutIds[rowIndex]; | |
66 | if (timeoutId) { | |
67 | clearTimeout(timeoutId); | |
68 | } | |
15d79143 | 69 | this._rowTimeoutIds[rowIndex] = setTimeout(this._linkifyRow.bind(this, rowIndex), Linkifier.TIME_BEFORE_LINKIFY); |
2207d356 DI |
70 | } |
71 | ||
7167b06b | 72 | /** |
3bf31aa4 DI |
73 | * Attaches a handler for hypertext links, overriding default <a> behavior |
74 | * for standard http(s) links. | |
7167b06b DI |
75 | * @param {LinkHandler} handler The handler to use, this can be cleared with |
76 | * null. | |
77 | */ | |
4c99c032 | 78 | public attachHypertextLinkHandler(handler: LinkMatcherHandler): void { |
7167b06b DI |
79 | this._linkMatchers[HYPERTEXT_LINK_MATCHER_ID].handler = handler; |
80 | } | |
81 | ||
82 | /** | |
83 | * Registers a link matcher, allowing custom link patterns to be matched and | |
84 | * handled. | |
3b62aa44 | 85 | * @param {RegExp} regex The regular expression to search for, specifically |
1ee774d0 DI |
86 | * this searches the textContent of the rows. You will want to use \s to match |
87 | * a space ' ' character for example. | |
7167b06b | 88 | * @param {LinkHandler} handler The callback when the link is called. |
6198556e | 89 | * @param {LinkMatcherOptions} [options] Options for the link matcher. |
7167b06b DI |
90 | * @return {number} The ID of the new matcher, this can be used to deregister. |
91 | */ | |
4c99c032 | 92 | public registerLinkMatcher(regex: RegExp, handler: LinkMatcherHandler, options: LinkMatcherOptions = {}): number { |
5183332f | 93 | if (this._nextLinkMatcherId !== HYPERTEXT_LINK_MATCHER_ID && !handler) { |
7167b06b DI |
94 | throw new Error('handler cannot be falsy'); |
95 | } | |
96 | const matcher: LinkMatcher = { | |
5183332f | 97 | id: this._nextLinkMatcherId++, |
7167b06b | 98 | regex, |
c8bb3216 | 99 | handler, |
6198556e | 100 | matchIndex: options.matchIndex, |
7ac4f1a9 DI |
101 | validationCallback: options.validationCallback, |
102 | priority: options.priority || 0 | |
7167b06b | 103 | }; |
7ac4f1a9 | 104 | this._addLinkMatcherToList(matcher); |
7167b06b DI |
105 | return matcher.id; |
106 | } | |
107 | ||
7ac4f1a9 DI |
108 | /** |
109 | * Inserts a link matcher to the list in the correct position based on the | |
110 | * priority of each link matcher. New link matchers of equal priority are | |
111 | * considered after older link matchers. | |
112 | * @param matcher The link matcher to be added. | |
113 | */ | |
114 | private _addLinkMatcherToList(matcher: LinkMatcher): void { | |
115 | if (this._linkMatchers.length === 0) { | |
116 | this._linkMatchers.push(matcher); | |
117 | return; | |
118 | } | |
119 | ||
120 | for (let i = this._linkMatchers.length - 1; i >= 0; i--) { | |
78d5fc95 | 121 | if (matcher.priority <= this._linkMatchers[i].priority) { |
7ac4f1a9 DI |
122 | this._linkMatchers.splice(i + 1, 0, matcher); |
123 | return; | |
124 | } | |
125 | } | |
126 | ||
78d5fc95 | 127 | this._linkMatchers.splice(0, 0, matcher); |
7ac4f1a9 DI |
128 | } |
129 | ||
7167b06b DI |
130 | /** |
131 | * Deregisters a link matcher if it has been registered. | |
132 | * @param {number} matcherId The link matcher's ID (returned after register) | |
1c030f57 | 133 | * @return {boolean} Whether a link matcher was found and deregistered. |
7167b06b | 134 | */ |
1c030f57 | 135 | public deregisterLinkMatcher(matcherId: number): boolean { |
7167b06b DI |
136 | // ID 0 is the hypertext link matcher which cannot be deregistered |
137 | for (let i = 1; i < this._linkMatchers.length; i++) { | |
138 | if (this._linkMatchers[i].id === matcherId) { | |
139 | this._linkMatchers.splice(i, 1); | |
1c030f57 | 140 | return true; |
7167b06b DI |
141 | } |
142 | } | |
1c030f57 | 143 | return false; |
2207d356 DI |
144 | } |
145 | ||
146 | /** | |
147 | * Linkifies a row. | |
148 | * @param {number} rowIndex The index of the row to linkify. | |
149 | */ | |
150 | private _linkifyRow(rowIndex: number): void { | |
c4f43184 DI |
151 | const row = this._rows[rowIndex]; |
152 | if (!row) { | |
153 | return; | |
154 | } | |
155 | const text = row.textContent; | |
e6fc80c1 | 156 | for (let i = 0; i < this._linkMatchers.length; i++) { |
7167b06b | 157 | const matcher = this._linkMatchers[i]; |
1ee774d0 | 158 | const uri = this._findLinkMatch(text, matcher.regex, matcher.matchIndex); |
7167b06b | 159 | if (uri) { |
6198556e DI |
160 | const linkElement = this._doLinkifyRow(rowIndex, uri, matcher.handler); |
161 | // Fire validation callback | |
dcffaf1c | 162 | if (linkElement && matcher.validationCallback) { |
6198556e DI |
163 | matcher.validationCallback(uri, isValid => { |
164 | if (!isValid) { | |
165 | linkElement.classList.add(INVALID_LINK_CLASS); | |
166 | } | |
167 | }); | |
168 | } | |
7167b06b DI |
169 | // Only allow a single LinkMatcher to trigger on any given row. |
170 | return; | |
171 | } | |
a489037e | 172 | } |
7167b06b | 173 | } |
a489037e | 174 | |
7167b06b DI |
175 | /** |
176 | * Linkifies a row given a specific handler. | |
177 | * @param {number} rowIndex The index of the row to linkify. | |
178 | * @param {string} uri The uri that has been found. | |
179 | * @param {handler} handler The handler to trigger when the link is triggered. | |
6198556e | 180 | * @return The link element if it was added, otherwise undefined. |
7167b06b | 181 | */ |
4c99c032 | 182 | private _doLinkifyRow(rowIndex: number, uri: string, handler?: LinkMatcherHandler): HTMLElement { |
a489037e DI |
183 | // Iterate over nodes as we want to consider text nodes |
184 | const nodes = this._rows[rowIndex].childNodes; | |
185 | for (let i = 0; i < nodes.length; i++) { | |
186 | const node = nodes[i]; | |
187 | const searchIndex = node.textContent.indexOf(uri); | |
188 | if (searchIndex >= 0) { | |
7167b06b | 189 | const linkElement = this._createAnchorElement(uri, handler); |
99a27021 | 190 | if (node.textContent.length === uri.length) { |
a489037e | 191 | // Matches entire string |
26ebc3d9 DI |
192 | |
193 | if (node.nodeType === 3 /*Node.TEXT_NODE*/) { | |
a489037e DI |
194 | this._replaceNode(node, linkElement); |
195 | } else { | |
a489037e | 196 | const element = (<HTMLElement>node); |
c8bb3216 DI |
197 | if (element.nodeName === 'A') { |
198 | // This row has already been linkified | |
199 | return; | |
200 | } | |
a489037e DI |
201 | element.innerHTML = ''; |
202 | element.appendChild(linkElement); | |
203 | } | |
204 | } else { | |
205 | // Matches part of string | |
a489037e DI |
206 | this._replaceNodeSubstringWithNode(node, linkElement, uri, searchIndex); |
207 | } | |
6198556e | 208 | return linkElement; |
a489037e | 209 | } |
2207d356 DI |
210 | } |
211 | } | |
212 | ||
213 | /** | |
1ee774d0 DI |
214 | * Finds a link match in a piece of text. |
215 | * @param {string} text The text to search. | |
c8bb3216 | 216 | * @param {number} matchIndex The regex match index of the link. |
a489037e | 217 | * @return {string} The matching URI or null if not found. |
2207d356 | 218 | */ |
1ee774d0 DI |
219 | private _findLinkMatch(text: string, regex: RegExp, matchIndex?: number): string { |
220 | const match = text.match(regex); | |
2207d356 DI |
221 | if (!match || match.length === 0) { |
222 | return null; | |
223 | } | |
c8bb3216 | 224 | return match[typeof matchIndex !== 'number' ? 0 : matchIndex]; |
2207d356 | 225 | } |
a489037e DI |
226 | |
227 | /** | |
228 | * Creates a link anchor element. | |
229 | * @param {string} uri The uri of the link. | |
230 | * @return {HTMLAnchorElement} The link. | |
231 | */ | |
4c99c032 | 232 | private _createAnchorElement(uri: string, handler: LinkMatcherHandler): HTMLAnchorElement { |
26ebc3d9 | 233 | const element = this._document.createElement('a'); |
a489037e | 234 | element.textContent = uri; |
7167b06b | 235 | if (handler) { |
c7b4c2be DI |
236 | element.addEventListener('click', (event: KeyboardEvent) => { |
237 | // Don't execute the handler if the link is flagged as invalid | |
238 | if (element.classList.contains(INVALID_LINK_CLASS)) { | |
239 | return; | |
240 | } | |
241 | // Require ctrl on click | |
242 | if (event.ctrlKey) { | |
6198556e DI |
243 | handler(uri); |
244 | } | |
245 | }); | |
a489037e DI |
246 | } else { |
247 | element.href = uri; | |
0f3ee21d DI |
248 | // Force link on another tab so work is not lost |
249 | element.target = '_blank'; | |
c7b4c2be DI |
250 | element.addEventListener('click', (event: KeyboardEvent) => { |
251 | // Require ctrl on click | |
252 | if (!event.ctrlKey) { | |
253 | event.preventDefault(); | |
254 | return false; | |
255 | } | |
256 | }); | |
a489037e DI |
257 | } |
258 | return element; | |
259 | } | |
260 | ||
261 | /** | |
262 | * Replace a node with 1 or more other nodes. | |
263 | * @param {Node} oldNode The node to replace. | |
264 | * @param {Node[]} newNodes The new nodes to insert in order. | |
265 | */ | |
266 | private _replaceNode(oldNode: Node, ...newNodes: Node[]): void { | |
267 | const parent = oldNode.parentNode; | |
268 | for (let i = 0; i < newNodes.length; i++) { | |
269 | parent.insertBefore(newNodes[i], oldNode); | |
270 | } | |
271 | parent.removeChild(oldNode); | |
272 | } | |
273 | ||
274 | /** | |
275 | * Replace a substring within a node with a new node. | |
0f3ee21d DI |
276 | * @param {Node} targetNode The target node; either a text node or a <span> |
277 | * containing a single text node. | |
a489037e DI |
278 | * @param {Node} newNode The new node to insert. |
279 | * @param {string} substring The substring to replace. | |
280 | * @param {number} substringIndex The index of the substring within the string. | |
281 | */ | |
282 | private _replaceNodeSubstringWithNode(targetNode: Node, newNode: Node, substring: string, substringIndex: number): void { | |
283 | let node = targetNode; | |
26ebc3d9 | 284 | if (node.nodeType !== 3/*Node.TEXT_NODE*/) { |
a489037e DI |
285 | node = node.childNodes[0]; |
286 | } | |
0f3ee21d DI |
287 | |
288 | // The targetNode will be either a text node or a <span>. The text node | |
289 | // (targetNode or its only-child) needs to be replaced with newNode plus new | |
290 | // text nodes potentially on either side. | |
a489037e DI |
291 | if (node.childNodes.length === 0 && node.nodeType !== Node.TEXT_NODE) { |
292 | throw new Error('targetNode must be a text node or only contain a single text node'); | |
293 | } | |
294 | ||
295 | const fullText = node.textContent; | |
296 | ||
297 | if (substringIndex === 0) { | |
298 | // Replace with <newNode><textnode> | |
a489037e | 299 | const rightText = fullText.substring(substring.length); |
26ebc3d9 | 300 | const rightTextNode = this._document.createTextNode(rightText); |
a489037e DI |
301 | this._replaceNode(node, newNode, rightTextNode); |
302 | } else if (substringIndex === targetNode.textContent.length - substring.length) { | |
303 | // Replace with <textnode><newNode> | |
a489037e | 304 | const leftText = fullText.substring(0, substringIndex); |
26ebc3d9 | 305 | const leftTextNode = this._document.createTextNode(leftText); |
a489037e DI |
306 | this._replaceNode(node, leftTextNode, newNode); |
307 | } else { | |
308 | // Replace with <textnode><newNode><textnode> | |
a489037e | 309 | const leftText = fullText.substring(0, substringIndex); |
26ebc3d9 | 310 | const leftTextNode = this._document.createTextNode(leftText); |
a489037e | 311 | const rightText = fullText.substring(substringIndex + substring.length); |
26ebc3d9 | 312 | const rightTextNode = this._document.createTextNode(rightText); |
a489037e DI |
313 | this._replaceNode(node, leftTextNode, newNode, rightTextNode); |
314 | } | |
315 | } | |
2207d356 | 316 | } |