diff --git a/Tests/spec/MailerIdentitySignature6168Spec.mjs b/Tests/spec/MailerIdentitySignature6168Spec.mjs new file mode 100644 index 000000000..1697c6a1f --- /dev/null +++ b/Tests/spec/MailerIdentitySignature6168Spec.mjs @@ -0,0 +1,653 @@ +import { readFileSync } from 'fs' +import { fileURLToPath } from 'url' + +describe('identity switch duplicates the signature (#6168)', function() { + let MessageEditorController + + beforeAll(function() { + let editorController + const moduleChain = { + controller: function(name, controller) { + if (name == 'MessageEditorController') + editorController = controller + return moduleChain + } + } + const angularStub = { + isDefined: function(value) { return value !== undefined }, + isUndefined: function(value) { return value === undefined }, + isNumber: function(value) { return typeof value == 'number' }, + module: function() { return moduleChain } + } + const source = readFileSync(fileURLToPath(new URL('../../UI/WebServerResources/js/Mailer/MessageEditorController.js', import.meta.url)), 'utf8') + new Function('angular', '_', 'screen', `${source} + return angular.module('SOGo.MailerUI');`)(angularStub, + { find: function(collection, predicate) { return collection.find(predicate) } }, + { orientation: { type: 'landscape-primary' } }) + MessageEditorController = editorController + }) + + const identityA = { full: 'Alice Agency ' } + const identityB = { full: 'Bob ' } + const identityShared = { full: 'Shared mailbox ' } + + function inserted(composeType, placement, signature) { + const html = composeType != 'text' + const nl = html ? '
' : '\n' + const space = html ? ' ' : ' ' + const n = placement == 'below' ? 1 : 2 + if (!signature) + return '' + return nl.repeat(n) + '--' + space + nl + signature + } + + function newEditor(text, options) { + options = options || {} + const signatureA = options.signatureA + const signatureB = options.signatureB + const identities = options.identities || [ + { full: identityA.full, signature: signatureA }, + { full: identityB.full, signature: signatureB } + ] + const stateMessage = { + editable: { + from: identityA.full, + to: [], cc: [], bcc: [], + text: text + }, + origin: options.origin, + $absolutePath: function() { return '/dav/drafts/123' } + } + class FileUploader { + constructor(uploaderOptions) { this.url = uploaderOptions.url } + } + const Preferences = { + defaults: { + SOGoMailAutoSave: 0, + SOGoMailUseSignatureOnNew: options.useOnNew === undefined ? 1 : options.useOnNew, + SOGoMailUseSignatureOnForward: options.useOnForward === undefined ? 1 : options.useOnForward, + SOGoMailUseSignatureOnReply: options.useOnReply === undefined ? 1 : options.useOnReply, + SOGoMailComposeMessageType: options.composeType || 'html', + SOGoMailSignaturePlacement: options.signaturePlacement || 'above', + SOGoMailReplyPlacement: options.replyPlacement || 'above' + } + } + const editor = new MessageEditorController({ $on: function() {} }, {}, {}, {}, {}, {}, FileUploader, + { isPopup: false }, + { identities: identities }, + stateMessage, + function() {}, function(value) { return value }, function() {}, + { toastPosition: 'bottom right' }, function() {}, {}, {}, {}, Preferences) + editor.$onInit() + return editor + } + + function switchTo(editor, signature) { + const identity = signature === undefined + ? { full: identityShared.full } + : { full: identityB.full, signature: signature } + editor.setFromIdentity(identity) + } + + const plainB = 'Bob' + const textB = 'Bob' + + const replacements = [ + { + name: 'keeps a single signature when the HTML has no metacharacters', + signatureA: 'Alice Agency
Sales', + signatureB: plainB + }, + { + name: 'replaces a signature that contains parentheses', + signatureA: 'Alice', + signatureB: plainB + }, + { + name: 'replaces a signature that contains dots', + signatureA: 'Alice', + signatureB: plainB + }, + { + name: 'replaces a signature that contains a plus', + signatureA: 'Tel +33 1 23 45 67 89', + signatureB: plainB + }, + { + name: 'replaces a signature that contains a question mark', + signatureA: 'Alice', + signatureB: plainB + }, + { + name: 'replaces a signature whose braces are not a quantifier', + signatureA: 'Alice', + signatureB: plainB + }, + { + name: 'replaces a signature whose braces are a quantifier', + signatureA: 'range {1,2} Alice', + signatureB: plainB + }, + { + name: 'replaces a signature that contains square brackets', + signatureA: 'Team [Sales]', + signatureB: plainB + }, + { + name: 'replaces a signature that contains a pipe', + signatureA: 'Alice|Agency', + signatureB: plainB + }, + { + name: 'replaces a signature that contains a star', + signatureA: 'Alice * Agency', + signatureB: plainB + }, + { + name: 'replaces a signature that starts with a star', + signatureA: '* Alice', + signatureB: plainB + }, + { + name: 'replaces a signature that contains a backslash', + signatureA: 'C:\\docs\\alice', + signatureB: plainB + }, + { + name: 'replaces a signature that contains a hash', + signatureA: 'Alice', + signatureB: plainB + }, + { + name: 'replaces the reporter signature (rgb, dotted font-size, url query)', + signatureA: 'Alice Agency
https://example.com/?from=sig', + signatureB: 'Bob' + }, + { + name: 'replaces an external image whose url has a query string', + signatureA: 'Alice', + signatureB: plainB + }, + { + name: 'replaces an external image url that only contains dots', + signatureA: 'Alice', + signatureB: plainB + }, + { + name: 'replaces a signature placed below the message', + placement: 'below', + signatureA: 'Alice', + signatureB: plainB + }, + { + name: 'replaces a plain-text signature', + composeType: 'text', + signatureA: 'Alice Agency\nSales', + signatureB: textB + }, + { + name: 'replaces a plain-text signature that contains parentheses, plus and a question mark', + composeType: 'text', + signatureA: 'Alice (Agency) +33\nhttps://example.com/?from=sig', + signatureB: textB + }, + { + name: 'replaces a plain-text signature placed below the message', + composeType: 'text', + placement: 'below', + signatureA: 'Alice (Agency)', + signatureB: textB + } + ] + + const unusual = [ + { + name: 'replaces an unusual signature with accents, guillemets, euro and an emoji', + signatureA: 'Alice Dupont — Agence « Été » 10 € 🌞', + signatureB: plainB + }, + { + name: 'replaces an unusual signature that mixes CJK and latin', + signatureA: '田中 アリス / Alice Tanaka', + signatureB: plainB + }, + { + name: 'replaces an unusual signature laid out as a table', + signatureA: '
AliceSales
ParisNord
', + signatureB: plainB + }, + { + name: 'replaces an unusual signature made of HTML entities', + signatureA: 'Alice & Bob <sales> "Nord"', + signatureB: plainB + }, + { + name: 'replaces an unusual signature that contains a delimiter lookalike', + signatureA: 'Alice -- directrice
-- ne pas effacer le message', + signatureB: plainB + }, + { + name: 'replaces an unusual signature with nested inline tags', + signatureA: 'Alice Agency', + signatureB: plainB + }, + { + name: 'replaces an unusual signature that is a list', + signatureA: '
  • Tel 01 02 03
  • Paris
', + signatureB: plainB + }, + { + name: 'replaces an unusual signature that starts with an HTML comment', + signatureA: 'Alice Agency', + signatureB: plainB + }, + { + name: 'replaces an unusual signature that uses single-quoted attributes', + signatureA: "Alice", + signatureB: plainB + }, + { + name: 'replaces an unusual signature that is only non-breaking spaces', + signatureA: '  ', + signatureB: plainB + }, + { + name: 'replaces an unusual signature with a zero-width space, an ellipsis and a percent', + signatureA: 'Alice\u200b… 100%', + signatureB: plainB + }, + { + name: 'inserts an unusual signature unchanged when replacing a plain one', + signatureA: 'Alice', + signatureB: 'Bob — « Nord » 🌞 & fils' + } + ] + + replacements.forEach(function(spec) { + const composeType = spec.composeType || 'html' + const placement = spec.placement || 'above' + + it(spec.name, function() { + const prefix = 'Hello' + const suffix = composeType == 'text' ? '\nPS keep' : '
PS keep' + const editor = newEditor(prefix + inserted(composeType, placement, spec.signatureA) + suffix, { + composeType: composeType, + signaturePlacement: placement, + signatureA: spec.signatureA, + signatureB: spec.signatureB + }) + + switchTo(editor, spec.signatureB) + + expect(editor.message.editable.text) + .toBe(prefix + inserted(composeType, placement, spec.signatureB) + suffix) + }) + }) + + unusual.forEach(function(spec) { + it(spec.name, function() { + const prefix = 'Hello' + const suffix = '
PS keep' + const editor = newEditor(prefix + inserted('html', 'above', spec.signatureA) + suffix, { + signatureA: spec.signatureA, + signatureB: spec.signatureB + }) + + switchTo(editor, spec.signatureB) + + const text = editor.message.editable.text + expect(text.startsWith(prefix)).toBe(true) + expect(text.endsWith(suffix)).toBe(true) + expect(text).not.toContain(spec.signatureA) + expect(text.split(spec.signatureB).length - 1).toBe(1) + }) + }) + + it('removes the previous HTML signature when the new identity has none', function() { + const signatureA = 'Alice' + const editor = newEditor('Hello' + inserted('html', 'above', signatureA), { + signatureA: signatureA + }) + + switchTo(editor) + + expect(editor.message.editable.text).toBe('Hello') + }) + + it('removes a plain-text signature when the new identity has none', function() { + const signatureA = 'Alice (Agency)' + const editor = newEditor('Hello' + inserted('text', 'above', signatureA), { + composeType: 'text', + signatureA: signatureA + }) + + switchTo(editor) + + expect(editor.message.editable.text).toBe('Hello') + }) + + it('replaces the signature after the editor rewrote inner line breaks', function() { + const signatureA = 'Alice
Sales' + const editor = newEditor('Hello

-- 
Alice
Sales', { + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB)) + }) + + it('replaces the signature after the editor wrapped it in a paragraph', function() { + const signatureA = 'Alice
https://example.com/?from=sig' + const editor = newEditor('

Hello



-- 
Alice
https://example.com/?from=sig

', { + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('

Hello

' + inserted('html', 'above', plainB)) + }) + + it('replaces a base64 image signature that exceeds the regex size limit', function() { + const signatureA = '' + const editor = newEditor('Hello' + inserted('html', 'above', signatureA), { + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB)) + }) + + it('replaces an unbalanced parenthesis instead of appending', function() { + const signatureA = 'Call me (Alice' + const editor = newEditor('Hello' + inserted('html', 'above', signatureA), { + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB)) + }) + + it('does not append when another identity earlier in the list has an invalid signature', function() { + const signatureA = 'Alice' + const editor = newEditor('Hello' + inserted('html', 'above', signatureA), { + signatureA: signatureA, + signatureB: plainB, + identities: [ + { full: 'Broken ', signature: 'note (draft' }, + { full: identityA.full, signature: signatureA }, + { full: identityB.full, signature: plainB } + ] + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB)) + }) + + it('keeps a single signature across two switches', function() { + const signatureA = 'Alice' + const signatureB = 'Bob' + const editor = newEditor('Hello' + inserted('html', 'above', signatureA), { + signatureA: signatureA, + signatureB: signatureB + }) + + switchTo(editor, signatureB) + editor.setFromIdentity({ full: identityA.full, signature: signatureA }) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', signatureA)) + }) + + it('leaves the draft unchanged when the selected identity is already the current one', function() { + const signatureA = 'Alice' + const editor = newEditor('Hello' + inserted('html', 'above', signatureA), { + signatureA: signatureA, + signatureB: plainB + }) + + editor.setFromIdentity({ full: identityA.full, signature: signatureA }) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', signatureA)) + }) + + it('appends exactly one signature when the draft has none yet', function() { + const editor = newEditor('Hello', { + signatureA: 'Alice', + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB)) + }) + + it('replaces the signature above a reply quote', function() { + const signatureA = 'Alice' + const quote = '

quoted
' + const editor = newEditor('Hello' + inserted('html', 'above', signatureA) + quote, { + signatureA: signatureA, + signatureB: plainB, + origin: { action: 'reply' } + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB) + quote) + }) + + it('replaces the signature of the first identity when six identities are configured', function() { + const signatureA = 'Alice' + const identities = [ { full: identityA.full, signature: signatureA } ] + for (let i = 2; i <= 5; i++) + identities.push({ full: 'User ' + i + ' ', signature: 'User ' + i + '' }) + identities.push({ full: identityB.full, signature: plainB }) + const editor = newEditor('Hello' + inserted('html', 'above', signatureA), { + signatureA: signatureA, + signatureB: plainB, + identities: identities + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB)) + }) + + it('inserts one signature above a plain-text reply quote', function() { + const quote = '\n\nOn January 1, 2026 at 10:00, a@example.com wrote:\n\n> quoted' + const editor = newEditor(quote, { + composeType: 'text', + origin: { action: 'reply' }, + signatureA: 'Alice', + signatureB: textB + }) + + switchTo(editor, textB) + + expect(editor.message.editable.text) + .toBe('\n' + inserted('text', 'above', textB) + + '\nOn January 1, 2026 at 10:00, a@example.com wrote:\n\n> quoted') + }) + + it('inserts one signature above an HTML reply quote that uses br without a slash', function() { + const quote = '
On January 1, 2026 at 10:00, a@example.com wrote:

quoted
' + const editor = newEditor('Hello' + quote, { + origin: { action: 'reply' }, + signatureA: 'Alice', + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB) + quote) + }) + + it('replaces the signature and keeps the forwarded body', function() { + const signatureA = 'Alice' + const forwarded = '

forwarded
' + const editor = newEditor('Hello' + inserted('html', 'above', signatureA) + forwarded, { + origin: { action: 'forward' }, + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB) + forwarded) + }) + + it('appends one signature at the end of a reply when the reply is placed below', function() { + const quote = 'On January 1, 2026 at 10:00, a@example.com wrote:

quoted
' + const editor = newEditor(quote, { + origin: { action: 'reply' }, + replyPlacement: 'below', + signatureA: 'Alice', + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe(quote + inserted('html', 'above', plainB)) + }) + + it('does not change the draft when signatures are disabled on a new message', function() { + const signatureA = 'Alice' + const body = 'Hello' + inserted('html', 'above', signatureA) + const editor = newEditor(body, { + useOnNew: 0, + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.from).toBe(identityB.full) + expect(editor.message.editable.text).toBe(body) + }) + + it('does not change the draft when signatures are disabled on reply', function() { + const signatureA = 'Alice' + const body = 'Hello' + inserted('html', 'above', signatureA) + const editor = newEditor(body, { + useOnReply: 0, + origin: { action: 'reply' }, + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe(body) + }) + + it('removes the previous signature when a shared identity has none', function() { + const signatureA = 'Alice' + const quote = '

quoted
' + const editor = newEditor('Hello' + inserted('html', 'above', signatureA) + quote, { + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor) + + expect(editor.message.editable.from).toBe(identityShared.full) + expect(editor.message.editable.text).toBe('Hello' + quote) + }) + + it('keeps an HTML signature as HTML when the compose mode is plain text', function() { + const signatureA = 'Alice
Sales' + const signatureB = 'Bob' + const editor = newEditor('Hello' + inserted('text', 'above', signatureA), { + composeType: 'text', + signatureA: signatureA, + signatureB: signatureB + }) + + switchTo(editor, signatureB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('text', 'above', signatureB)) + }) + + it('keeps a user-written dashed line and appends the new signature once', function() { + const body = 'Hello

-- 
see you tomorrow' + const editor = newEditor(body, { + signatureA: 'Alice', + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe(body + inserted('html', 'above', plainB)) + }) + + it('does not splice a signature the user has edited', function() { + const signatureA = 'Alice
Sales' + const body = 'Hello

-- 
Alice
Edited' + const editor = newEditor(body, { + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe(body + inserted('html', 'above', plainB)) + }) + + it('replaces a signature that has only one break before the delimiter', function() { + const signatureA = 'Alice' + const editor = newEditor('Hello
-- 
' + signatureA + '
PS keep', { + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', plainB) + '
PS keep') + }) + + it('keeps a break that exceeds the usual delimiter', function() { + const signatureA = 'Alice' + const editor = newEditor('Hello


-- 
' + signatureA + '
PS keep', { + signatureA: signatureA, + signatureB: plainB + }) + + switchTo(editor, plainB) + + expect(editor.message.editable.text).toBe('Hello
' + inserted('html', 'above', plainB) + '
PS keep') + }) + + it('sets Reply-To from the identity and does not clear it afterwards', function() { + const editor = newEditor('Hello', { + signatureA: 'Alice', + signatureB: plainB + }) + + editor.setFromIdentity({ full: identityB.full, signature: plainB, replyTo: 'bob-reply@example.com' }) + expect(editor.message.editable.replyTo).toBe('bob-reply@example.com') + + editor.setFromIdentity({ full: identityA.full, signature: 'Alice' }) + + expect(editor.message.editable.replyTo).toBe('bob-reply@example.com') + expect(editor.message.editable.text).toBe('Hello' + inserted('html', 'above', 'Alice')) + }) + + it('leaves a single image when the same identity is selected again', function() { + const signatureA = '' + const body = 'Hello' + inserted('html', 'above', signatureA) + const editor = newEditor(body, { + signatureA: signatureA, + signatureB: plainB + }) + + editor.setFromIdentity({ full: identityA.full, signature: signatureA }) + + expect(editor.message.editable.text).toBe(body) + }) +}) diff --git a/UI/WebServerResources/js/Mailer/MessageEditorController.js b/UI/WebServerResources/js/Mailer/MessageEditorController.js index 947ac7e56..5325eb61d 100644 --- a/UI/WebServerResources/js/Mailer/MessageEditorController.js +++ b/UI/WebServerResources/js/Mailer/MessageEditorController.js @@ -385,7 +385,6 @@ this.setFromIdentity = function (identity) { var node, children, nl, reNl, nlNb, space, signature, previousIdentity; - var nl2, reNl2; if (identity && identity.full) { @@ -398,10 +397,8 @@ if (this.composeType == "html") { nl = '
'; - reNl = '
( )?[ \n]?'; + reNl = '
( )?[ \n]?'; space = ' '; - nl2 = '
'; - reNl2 = '
( )?[ \n]?'; } else { nl = '\n'; reNl = '\n'; @@ -423,24 +420,43 @@ else signature = ''; - previousIdentity = _.find(this.identities, function (currentIdentity, index) { + var breakAfterDash = (this.composeType == "html") ? '
' : reNl; + var signatureMarker = new RegExp('(

)?(?:' + reNl + '){1,' + nlNb + '}--' + space + breakAfterDash, 'g'); + var endOfSignature = function (text, from, currentSignature) { + var parts, at, i, br; - if (currentIdentity.signature) { - try { - //var currentSignature = new RegExp('(' + reNl + '){' + nlNb + '}--' + space + reNl + - // currentIdentity.signature.replace(/[-\[\]{}()*+?.,\\^$|#\s]/g, '\\$&')); - var currentSignature = new RegExp('(

)?(
( )?[ \\n]?)?-- 
( )?[ \\n]?(<\/p>)?' + currentIdentity.signature) - if (vm.message.editable.text.search(currentSignature) >= 0) { - vm.message.editable.text = vm.message.editable.text.replace(currentSignature, signature); - return true; - } - } catch (error) { - // An error can occur (regex too long) when the signature is too big (using images) - // In this case, just add the signature at the end (#5695) - vm.message.editable.text += signature; - return true; + parts = (vm.composeType == "html") ? currentSignature.split(/
/) : [currentSignature]; + at = from; + for (i = 0; i < parts.length; i++) { + if (i > 0) { + br = text.slice(at).match(/^
/); + if (!br) + return null; + at += br[0].length; } - + if (!text.startsWith(parts[i], at)) + return null; + at += parts[i].length; + } + if (vm.composeType == "html" && text.startsWith('

', at)) + at += '

'.length; + return at; + }; + + previousIdentity = _.find(this.identities, function (currentIdentity) { + var text, match, end; + + if (!currentIdentity.signature) + return false; + + text = vm.message.editable.text; + signatureMarker.lastIndex = 0; + while ((match = signatureMarker.exec(text))) { + end = endOfSignature(text, match.index + match[0].length, currentIdentity.signature); + if (end == null) + continue; + vm.message.editable.text = text.slice(0, match.index) + signature + text.slice(end); + return true; } return false; });