diff --git a/src/annotations/autolinks.ts b/src/annotations/autolinks.ts index 222c32e..627b535 100644 --- a/src/annotations/autolinks.ts +++ b/src/annotations/autolinks.ts @@ -14,7 +14,7 @@ import { encodeUrl } from '../system/encoding'; import { join, map } from '../system/iterable'; import type { PromiseCancelledErrorWithId } from '../system/promise'; import { PromiseCancelledError, raceAll } from '../system/promise'; -import { escapeHtmlWeak, escapeMarkdown, escapeRegex, getSuperscript } from '../system/string'; +import { encodeHtmlWeak, escapeMarkdown, escapeRegex, getSuperscript } from '../system/string'; const emptyAutolinkMap = Object.freeze(new Map()); @@ -32,16 +32,31 @@ export interface Autolink { } export interface CacheableAutolinkReference extends AutolinkReference { - linkify?: - | ((text: string, outputFormat: 'html' | 'markdown' | 'plaintext', footnotes?: Map) => string) + tokenize?: + | (( + text: string, + outputFormat: 'html' | 'markdown' | 'plaintext', + tokenMapping: Map, + issuesOrPullRequests?: Map, + footnotes?: Map, + ) => string) | null; + messageHtmlRegex?: RegExp; messageMarkdownRegex?: RegExp; messageRegex?: RegExp; } export interface DynamicAutolinkReference { - linkify: (text: string, outputFormat: 'html' | 'markdown' | 'plaintext', footnotes?: Map) => string; + tokenize?: + | (( + text: string, + outputFormat: 'html' | 'markdown' | 'plaintext', + tokenMapping: Map, + issuesOrPullRequests?: Map, + footnotes?: Map, + ) => string) + | null; parse: (text: string, autolinks: Map) => void; } @@ -204,11 +219,18 @@ export class Autolinks implements Disposable { remotes?: GitRemote[], issuesOrPullRequests?: Map, footnotes?: Map, - ) { + ): string { + const includeFootnotesInText = outputFormat === 'plaintext' && footnotes == null; + if (includeFootnotesInText) { + footnotes = new Map(); + } + + const tokenMapping = new Map(); + for (const ref of this._references) { - if (this.ensureAutolinkCached(ref, issuesOrPullRequests)) { - if (ref.linkify != null) { - text = ref.linkify(text, outputFormat, footnotes); + if (this.ensureAutolinkCached(ref)) { + if (ref.tokenize != null) { + text = ref.tokenize(text, outputFormat, tokenMapping, issuesOrPullRequests, footnotes); } } } @@ -218,87 +240,71 @@ export class Autolinks implements Disposable { if (r.provider == null) continue; for (const ref of r.provider.autolinks) { - if (this.ensureAutolinkCached(ref, issuesOrPullRequests)) { - if (ref.linkify != null) { - text = ref.linkify(text, outputFormat, footnotes); + if (this.ensureAutolinkCached(ref)) { + if (ref.tokenize != null) { + text = ref.tokenize(text, outputFormat, tokenMapping, issuesOrPullRequests, footnotes); } } } } } + if (tokenMapping.size !== 0) { + // eslint-disable-next-line no-control-regex + text = text.replace(/(\x00\d+\x00)/g, (_, t: string) => tokenMapping.get(t) ?? t); + } + + if (includeFootnotesInText && footnotes?.size) { + text += `\n${GlyphChars.Dash.repeat(2)}\n${join( + map(footnotes, ([i, footnote]) => `${getSuperscript(i)} ${footnote}`), + '\n', + )}`; + } + return text; } private ensureAutolinkCached( ref: CacheableAutolinkReference | DynamicAutolinkReference, - issuesOrPullRequests?: Map, ): ref is CacheableAutolinkReference | DynamicAutolinkReference { if (isDynamic(ref)) return true; if (!ref.prefix || !ref.url) return false; + if (ref.tokenize !== undefined || ref.tokenize === null) return true; try { - if (issuesOrPullRequests == null || issuesOrPullRequests.size === 0) { - ref.linkify = (text: string, outputFormat: 'html' | 'markdown' | 'plaintext') => { - switch (outputFormat) { - case 'html': { - ensureCachedRegex(ref, outputFormat); - return text.replace( - ref.messageHtmlRegex, - /*html*/ `$1`, - ); - } - case 'markdown': { - ensureCachedRegex(ref, outputFormat); - return text.replace( - ref.messageMarkdownRegex, - `[$1](${encodeUrl(ref.url.replace(numRegex, '$2'))}${ - ref.title ? ` "${ref.title.replace(numRegex, '$2')}"` : '' - })`, - ); - } - default: - return text; - } - }; - - return true; - } - - ref.linkify = ( + ref.tokenize = ( text: string, outputFormat: 'html' | 'markdown' | 'plaintext', + tokenMapping: Map, + issuesOrPullRequests?: Map, footnotes?: Map, ) => { - const includeFootnotes = footnotes == null; - let index; + let footnoteIndex: number; switch (outputFormat) { case 'markdown': ensureCachedRegex(ref, outputFormat); - return text.replace(ref.messageMarkdownRegex, (_substring, linkText, num) => { - const issue = issuesOrPullRequests?.get(num); - const issueUrl = encodeUrl(ref.url.replace(numRegex, num)); + return text.replace(ref.messageMarkdownRegex, (_: string, linkText: string, num: string) => { + const url = encodeUrl(ref.url.replace(numRegex, num)); let title = ''; if (ref.title) { title = ` "${ref.title.replace(numRegex, num)}`; + const issue = issuesOrPullRequests?.get(num); if (issue != null) { if (issue instanceof PromiseCancelledError) { title += `\n${GlyphChars.Dash.repeat(2)}\nDetails timed out`; } else { - const issueTitle = issue.title.replace(/([")\\])/g, '\\$1').trim(); + const issueTitle = escapeMarkdown(issue.title.trim()); if (footnotes != null) { - index = footnotes.size + 1; + footnoteIndex = footnotes.size + 1; footnotes.set( - index, + footnoteIndex, `[${IssueOrPullRequest.getMarkdownIcon( issue, - )} **${issueTitle}**](${issueUrl}${title}")\\\n${GlyphChars.Space.repeat( + )} **${issueTitle}**](${url}${title}")\\\n${GlyphChars.Space.repeat( 5, )}${linkText} ${issue.closed ? 'closed' : 'opened'} ${fromNow( issue.closedDate ?? issue.date, @@ -314,32 +320,32 @@ export class Autolinks implements Disposable { title += '"'; } - return `[${linkText}](${issueUrl}${title})`; + const token = `\x00${tokenMapping.size}\x00`; + tokenMapping.set(token, `[${linkText}](${url}${title})`); + return token; }); case 'html': ensureCachedRegex(ref, outputFormat); - return text.replace(ref.messageHtmlRegex, (_substring, linkText, num) => { - const issue = issuesOrPullRequests?.get(num); - const issueUrl = encodeUrl(ref.url.replace(numRegex, num)); + return text.replace(ref.messageHtmlRegex, (_: string, linkText: string, num: string) => { + const url = encodeUrl(ref.url.replace(numRegex, num)); let title = ''; if (ref.title) { - title = `"${escapeHtmlWeak(ref.title.replace(numRegex, num))}`; + title = `"${encodeHtmlWeak(ref.title.replace(numRegex, num))}`; + const issue = issuesOrPullRequests?.get(num); if (issue != null) { if (issue instanceof PromiseCancelledError) { title += `\n${GlyphChars.Dash.repeat(2)}\nDetails timed out`; } else { - const issueTitle = escapeHtmlWeak( - issue.title.replace(/([")\\])/g, '\\$1').trim(), - ); + const issueTitle = encodeHtmlWeak(issue.title.trim()); if (footnotes != null) { - index = footnotes.size + 1; + footnoteIndex = footnotes.size + 1; footnotes.set( - index, - `${IssueOrPullRequest.getHtmlIcon( + footnoteIndex, + `${IssueOrPullRequest.getHtmlIcon( issue, )} ${issueTitle}
${GlyphChars.Space.repeat( 5, @@ -357,39 +363,35 @@ export class Autolinks implements Disposable { title += '"'; } - return `${escapeHtmlWeak(linkText)}`; + const token = `\x00${tokenMapping.size}\x00`; + tokenMapping.set(token, `${linkText}`); + return token; }); default: ensureCachedRegex(ref, outputFormat); - text = text.replace(ref.messageRegex, (_substring, linkText: string, num) => { + return text.replace(ref.messageRegex, (_: string, linkText: string, num: string) => { const issue = issuesOrPullRequests?.get(num); if (issue == null) return linkText; - if (footnotes === undefined) { - footnotes = new Map(); + if (footnotes != null) { + footnoteIndex = footnotes.size + 1; + footnotes.set( + footnoteIndex, + `${linkText}: ${ + issue instanceof PromiseCancelledError + ? 'Details timed out' + : `${issue.title} ${GlyphChars.Dot} ${ + issue.closed ? 'Closed' : 'Opened' + }, ${fromNow(issue.closedDate ?? issue.date)}` + }`, + ); } - index = footnotes.size + 1; - footnotes.set( - index, - `${linkText}: ${ - issue instanceof PromiseCancelledError - ? 'Details timed out' - : `${issue.title} ${GlyphChars.Dot} ${ - issue.closed ? 'Closed' : 'Opened' - }, ${fromNow(issue.closedDate ?? issue.date)}` - }`, - ); - return `${linkText}${getSuperscript(index)}`; + const token = `\x00${tokenMapping.size}\x00`; + tokenMapping.set(token, `${linkText}${getSuperscript(footnoteIndex)}`); + return token; }); - - return includeFootnotes && footnotes != null && footnotes.size !== 0 - ? `${text}\n${GlyphChars.Dash.repeat(2)}\n${join( - map(footnotes, ([i, footnote]) => `${getSuperscript(i)} ${footnote}`), - '\n', - )}` - : text; } }; } catch (ex) { @@ -397,7 +399,7 @@ export class Autolinks implements Disposable { ex, `Failed to create autolink generator: prefix=${ref.prefix}, url=${ref.url}, title=${ref.title}`, ); - ref.linkify = null; + ref.tokenize = null; } return true; @@ -417,25 +419,23 @@ function ensureCachedRegex( outputFormat: 'plaintext', ): asserts ref is RequireSome; function ensureCachedRegex(ref: CacheableAutolinkReference, outputFormat: 'html' | 'markdown' | 'plaintext') { - // Regexes matches the ref prefix followed by a token and avoid re-matching previously matched tokens + // Regexes matches the ref prefix followed by a token (e.g. #1234) if (outputFormat === 'markdown' && ref.messageMarkdownRegex == null) { + // Extra `\\\\` in `\\\\\\[` is because the markdown is escaped ref.messageMarkdownRegex = new RegExp( - `(?<=^|\\s|\\(|\\\\\\[)(${escapeRegex(escapeMarkdown(ref.prefix))}([${ - ref.alphanumeric ? '\\w' : '0-9' - }]+))\\b`, + `(?<=^|\\s|\\(|\\\\\\[)(${escapeRegex(encodeHtmlWeak(escapeMarkdown(ref.prefix)))}(${ + ref.alphanumeric ? '\\w' : '\\d' + }+))\\b`, ref.ignoreCase ? 'gi' : 'g', ); } else if (outputFormat === 'html' && ref.messageHtmlRegex == null) { - // TODO@eamodio add proper html escaping to avoid matching previous replaced matches ref.messageHtmlRegex = new RegExp( - `(?<=^|\\s|\\(|\\\\\\[)(${escapeRegex(escapeHtmlWeak(ref.prefix))}([${ - ref.alphanumeric ? '\\w' : '0-9' - }]+))\\b`, + `(?<=^|\\s|\\(|\\[)(${escapeRegex(encodeHtmlWeak(ref.prefix))}(${ref.alphanumeric ? '\\w' : '\\d'}+))\\b`, ref.ignoreCase ? 'gi' : 'g', ); } else if (ref.messageRegex == null) { ref.messageRegex = new RegExp( - `(?<=^|\\s|\\(|\\\\\\[)(${escapeRegex(ref.prefix)}([${ref.alphanumeric ? '\\w' : '0-9'}]+))\\b`, + `(?<=^|\\s|\\(|\\[)(${escapeRegex(ref.prefix)}(${ref.alphanumeric ? '\\w' : '\\d'}+))\\b`, ref.ignoreCase ? 'gi' : 'g', ); } diff --git a/src/git/formatters/commitFormatter.ts b/src/git/formatters/commitFormatter.ts index 0bee6f3..f7b76d4 100644 --- a/src/git/formatters/commitFormatter.ts +++ b/src/git/formatters/commitFormatter.ts @@ -23,7 +23,7 @@ import type { ShowInCommitGraphCommandArgs } from '../../plus/webviews/graph/gra import { join, map } from '../../system/iterable'; import { PromiseCancelledError } from '../../system/promise'; import type { TokenOptions } from '../../system/string'; -import { escapeHtmlWeak, escapeMarkdown, getSuperscript } from '../../system/string'; +import { encodeHtmlWeak, escapeMarkdown, getSuperscript } from '../../system/string'; import type { ContactPresence } from '../../vsls/vsls'; import type { PreviousLineComparisonUrisResult } from '../gitProvider'; import type { GitCommit } from '../models/commit'; @@ -201,8 +201,8 @@ export class CommitFormatter extends Formatter { case 'markdown': return `[${author}](${email ? `mailto:${email} "Email ${name} (${email})"` : `# "${name}"`})`; case 'html': - name = escapeHtmlWeak(name); - email = escapeHtmlWeak(email); + name = encodeHtmlWeak(name); + email = encodeHtmlWeak(email); return /*html*/ ` { case 'markdown': return `[${author}](${email ? `mailto:${email} "Email ${name} (${email})"` : `# "${name}"`})`; case 'html': - name = escapeHtmlWeak(name); - email = escapeHtmlWeak(email); + name = encodeHtmlWeak(name); + email = encodeHtmlWeak(email); return /*html*/ ` { }${presence.statusText.toLocaleLowerCase()}`; if (outputFormat === 'html') { - title = escapeHtmlWeak(title); + title = encodeHtmlWeak(title); } const avatarPromise = this._getAvatar(outputFormat, title, this._options.avatarSize); @@ -293,7 +293,7 @@ export class CommitFormatter extends Formatter { } if (outputFormat === 'html') { - name = escapeHtmlWeak(name); + name = encodeHtmlWeak(name); } return this._getAvatar(outputFormat, name, this._options.avatarSize); } @@ -545,20 +545,9 @@ export class CommitFormatter extends Formatter { this._options.footnotes == null || this._options.footnotes.size === 0 ? '' : join( - map(this._options.footnotes, ([i, footnote]) => { - switch (outputFormat) { - case 'html': - return /*html*/ `${i} ${escapeHtmlWeak(footnote)}`; - case 'markdown': - return `${getSuperscript(i)} ${footnote}`; - default: - return footnote; - } - }), + map(this._options.footnotes, ([i, footnote]) => + outputFormat === 'plaintext' ? `${getSuperscript(i)} ${footnote}` : footnote, + ), outputFormat === 'html' ? /*html*/ `
` : outputFormat === 'markdown' ? '\\\n' : '\n', ), this._options.tokenOptions.footnotes, @@ -637,12 +626,15 @@ export class CommitFormatter extends Formatter { message = this._padOrTruncate(message, this._options.tokenOptions.message); if (outputFormat !== 'plaintext') { - message = escapeHtmlWeak(message); + message = encodeHtmlWeak(message); + } + if (outputFormat === 'markdown') { + message = escapeMarkdown(message, { quoted: true }); } if (this._options.messageAutolinks) { message = Container.instance.autolinks.linkify( - outputFormat === 'markdown' ? escapeMarkdown(message, { quoted: true }) : message, + message, outputFormat, this._options.remotes, this._options.autolinkedIssuesOrPullRequests, diff --git a/src/git/remotes/github.ts b/src/git/remotes/github.ts index 72a1929..ce8f4be 100644 --- a/src/git/remotes/github.ts +++ b/src/git/remotes/github.ts @@ -10,6 +10,7 @@ import type { import { isSubscriptionPaidPlan, isSubscriptionPreviewTrialExpired } from '../../subscription'; import { log } from '../../system/decorators/log'; import { memoize } from '../../system/decorators/memoize'; +import { encodeUrl } from '../../system/encoding'; import { equalsIgnoreCase } from '../../system/string'; import type { Account } from '../models/author'; import type { DefaultBranch } from '../models/defaultBranch'; @@ -71,11 +72,27 @@ export class GitHubRemote extends RichRemoteProvider { description: `Issue or Pull Request # on ${this.name}`, }, { - linkify: (text: string) => - text.replace( - autolinkFullIssuesRegex, - `[$&](${this.protocol}://${this.domain}/$/issues/$ "Open Issue or Pull Request #$ from $ on ${this.name}")`, - ), + tokenize: ( + text: string, + outputFormat: 'html' | 'markdown' | 'plaintext', + tokenMapping: Map, + ) => { + return outputFormat === 'plaintext' + ? text + : text.replace(autolinkFullIssuesRegex, (linkText: string, repo: string, num: string) => { + const url = encodeUrl(`${this.protocol}://${this.domain}/${repo}/issues/${num}`); + const title = ` "Open Issue or Pull Request #${num} from ${repo} on ${this.name}"`; + + const token = `\x00${tokenMapping.size}\x00`; + if (outputFormat === 'markdown') { + tokenMapping.set(token, `[${linkText}](${url}${title})`); + } else if (outputFormat === 'html') { + tokenMapping.set(token, `${linkText}`); + } + + return token; + }); + }, parse: (text: string, autolinks: Map) => { let repo: string; let num: string; diff --git a/src/git/remotes/gitlab.ts b/src/git/remotes/gitlab.ts index 99b2ff6..9fab660 100644 --- a/src/git/remotes/gitlab.ts +++ b/src/git/remotes/gitlab.ts @@ -10,6 +10,7 @@ import type { } from '../../plus/integrationAuthentication'; import { isSubscriptionPaidPlan, isSubscriptionPreviewTrialExpired } from '../../subscription'; import { log } from '../../system/decorators/log'; +import { encodeUrl } from '../../system/encoding'; import { equalsIgnoreCase } from '../../system/string'; import type { Account } from '../models/author'; import type { DefaultBranch } from '../models/defaultBranch'; @@ -67,11 +68,27 @@ export class GitLabRemote extends RichRemoteProvider { description: `Merge Request ! on ${this.name}`, }, { - linkify: (text: string) => - text.replace( - autolinkFullIssuesRegex, - `[$&](${this.protocol}://${this.domain}/$/-/issues/$ "Open Issue #$ from $ on ${this.name}")`, - ), + tokenize: ( + text: string, + outputFormat: 'html' | 'markdown' | 'plaintext', + tokenMapping: Map, + ) => { + return outputFormat === 'plaintext' + ? text + : text.replace(autolinkFullIssuesRegex, (linkText: string, repo: string, num: string) => { + const url = encodeUrl(`${this.protocol}://${this.domain}/${repo}/-/issues/${num}`); + const title = ` "Open Issue #${num} from ${repo} on ${this.name}"`; + + const token = `\x00${tokenMapping.size}\x00`; + if (outputFormat === 'markdown') { + tokenMapping.set(token, `[${linkText}](${url}${title})`); + } else if (outputFormat === 'html') { + tokenMapping.set(token, `${linkText}`); + } + + return token; + }); + }, parse: (text: string, autolinks: Map) => { let repo: string; let num: string; @@ -97,11 +114,32 @@ export class GitLabRemote extends RichRemoteProvider { }, }, { - linkify: (text: string) => - text.replace( - autolinkFullMergeRequestsRegex, - `[$&](${this.protocol}://${this.domain}/$/-/merge_requests/$ "Open Merge Request !$ from $ on ${this.name}")`, - ), + tokenize: ( + text: string, + outputFormat: 'html' | 'markdown' | 'plaintext', + tokenMapping: Map, + ) => { + return outputFormat === 'plaintext' + ? text + : text.replace( + autolinkFullMergeRequestsRegex, + (linkText: string, repo: string, num: string) => { + const url = encodeUrl( + `${this.protocol}://${this.domain}/${repo}/-/merge_requests/${num}`, + ); + const title = ` "Open Merge Request !${num} from ${repo} on ${this.name}"`; + + const token = `\x00${tokenMapping.size}\x00`; + if (outputFormat === 'markdown') { + tokenMapping.set(token, `[${linkText}](${url}${title})`); + } else if (outputFormat === 'html') { + tokenMapping.set(token, `${linkText}`); + } + + return token; + }, + ); + }, parse: (text: string, autolinks: Map) => { let repo: string; let num: string; diff --git a/src/system/string.ts b/src/system/string.ts index 775bc04..734f50d 100644 --- a/src/system/string.ts +++ b/src/system/string.ts @@ -94,9 +94,9 @@ export function compareSubstringIgnoreCase( return 0; } -export function escapeHtmlWeak(s: string): string; -export function escapeHtmlWeak(s: string | undefined): string | undefined; -export function escapeHtmlWeak(s: string | undefined): string | undefined { +export function encodeHtmlWeak(s: string): string; +export function encodeHtmlWeak(s: string | undefined): string | undefined; +export function encodeHtmlWeak(s: string | undefined): string | undefined { return s?.replace(/[<>&"]/g, c => { switch (c) { case '<':