Sanitize username in auth.createUser

Features
1

In an idprovider, users are created programatically. However the username is not sanitized, so creation will fail if say you pass in an email address, because ‘@’ is an invalid character.

I think createUser should sanitize the username automatically. Either that or have a method so it can be done before calling createUser.

I guess this could be useful for content names too. In content studio it happens on the fly when you type in a displayName. I could guess what characthers are illegal, but it would be much better to use the same method that is used in Enonic XP.

3 Likes
2

Support for ASCII isn’t to hard to implement.

!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~

But starting on UNICODE it’s becomes a huge job, take for instance these:

ÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄǍĂĀÃÅǺĄÆǼǢƁĆĊĈČÇĎḌĐƊÐÉÈĖÊËĚĔĒĘẸƎƏƐĠĜǦĞĢƔáàâäǎăāãåǻąæǽǣɓćċĉčçďḍđɗðéèėêëěĕēęẹǝəɛġĝǧğģɣĤḤĦIÍÌİÎÏǏĬĪĨĮỊIJĴĶƘĹĻŁĽĿʼNŃN̈ŇÑŅŊÓÒÔÖǑŎŌÕŐỌØǾƠŒĥḥħıíìiîïǐĭīĩįịijĵķƙĸĺļłľŀʼnńn̈ňñņŋóòôöǒŏōõőọøǿơœŔŘŖŚŜŠŞȘṢẞŤŢṬŦÞÚÙÛÜǓŬŪŨŰŮŲỤƯẂẀŴẄǷÝỲŶŸȲỸƳŹŻŽẒŕřŗſśŝšşșṣßťţṭŧþúùûüǔŭūũűůųụưẃẁŵẅƿýỳŷÿȳỹƴźżžẓ

Many of which are “translated”, not simply converted to “-”, some are simply removed.

So yeah access to the internal method would be useful…

3

Ascii and Norwegian chars would be something like this: (haven’t tested all scenarios)

exports.sanitizeName = function(name) {
	return name.toLowerCase()
		.replace(/[!"()]+/g, '') // ASCII removed.
		.replace(/[#$%&'*+,/:;<=>?@[\\\]^_`{|}~\s]+/g, '-') // ASCII replaced.
		.replace(/[æÆ]/g, 'ae').replace(/[øØ]/g, 'o').replace(/[åÅ]/g, 'a') // Norwegian chars.
		.replace(/--+/g, '-') // Two or more dashes becomes just one.
		.replace(/^[-.]+/, '') // Do not begin with - or .
		.replace(/[-.]+$/, ''); // Do not end in - or .
};
1 Like
4

Note: Added toLowerCase and \s to example above.

5

We are investigating this.

6

Making the character conversion covering all the possible cases is a bit complex, and JavaScript support for Unicode is limited.

I’m thinking of adding a function for this in lib-text-encoding, but you can already use the method from XP with this simple function:

function prettify(text) {
    var namePrettyfier = Java.type('com.enonic.xp.name.NamePrettyfier');
    return namePrettyfier.create(text);
}
7

Hi @aro,

We want to add this to lib-common. Can you create a task for this?

Regards,
Morten

8

Task made: https://github.com/enonic/xp/issues/4935