Entry filter not working with titles containing Ampersands

[animaux]

Symphony 2.6.1

A similiar problem to this JS-related problem:

When I try to filter a list of entries in in index view by a regular input field with a value containing an ampersand, the value reverts to only the word before the ampersand. Here are my steps:

1. create a new filter in index view, and filter by input field title
2. filter by value is and select a value from the pop-up of existing values f. e. »Bilden & Betten«
3. the filter reverts to »Bilden« and the result thus is no entry

Probably the ampersand needs to be escaped/encoded at some point and isn’t. Typing »Bilden & Betten« by hand instead of clicking the existing value yields the same result.

[michael-e]

Reminds me of #2349. (But in that case escaping with a backslash helped. I don't know what's the solution for ampersands.)

[michael-e]

Ah, got it: Replacing the ampersand by %26 in the URL works. So it can probably be solved similar to #2349.

[animaux]

Brilliant, sounds good! Thanks Michael.

[michael-e]

Something like adding value.replace('&', '%26'); after this line. Could you test that, @animaux ?

[michael-e]

Ah, sorry, again we'd only replace the first occurence with that…

[michael-e]

See #2420. We must either split the string or use regex. @nitriques suggested regex last time, but we kept the split in the end. Time to give it another thought. We should make it consistent.

Solution 1:

input.val(value.split(',').join('\\,'));
input.val(value.split('&').join('%26'));

Solution 2:

input.val(value.replace(/,/g, '\\,'));
input.val(value.replace(/&/g, '%26'));

@nitriques, @brendo?

[brendo]

Nah, this is getting a little hacky. We should fully encode the values using encodeURIComponent which will handle all special characters.

[michael-e]

Unfortunately, that doesnt' work, because it will encode , as %2C. For some reason we need to escape this as \,.

The output of

encodeURIComponent('test1, test2 & test3');

is test1%2C%20test2%20%26%20test3, but we need test1\,%20test2%20%26%20test3 for the filter to work correctly.

[brendo]

What a bloody mess. You are correct, we need \, because the
Datasource::determineFilterType looks for the specific pattern of commas
escaped by backslashes.

Perhaps the Q&D method is the best way after all.

On Wed, May 20, 2015 at 8:20 PM, michael-e notifications@github.com wrote:

Unfortunately, that doesnt' work, because it will encode , as %2C. For
some reason we need to escape this as \ ,.

The output of

encodeURIComponent('test1, test2 & test3');

is test1%2C%20test2%20%26%20test3, but we need
test1,%20test2%20%26%20test3 for the filter to work correctly.

—
Reply to this email directly or view it on GitHub
#2446 (comment)
.

[michael-e]

Which route? Split or regex replace? (I am by no means an expert in JS.)

[brendo]

Either or, something like the following should do the trick:

value = value.replace(/,/g, '\\,').replace(/&/g, '%26');
input.val(value);

[michael-e]

Looks good to me, but needs testing nevertheless. Shall we pass the testing job to @animaux? :-)

It's this line:

input.val(value.split(',').join('\\,'));

which would be replaced by these two lines:

value = value.replace(/,/g, '\\,').replace(/&/g, '%26');
input.val(value);

[animaux]

Ok, did that. Do I have to recompile symphony.min.js or is this done on-the-fly? In case not, how do I do this?

[michael-e]

Ah, I just noticed that it's a bit hard to test, because Symphony sends the minified JS file…

I have no idea how to recompile the minified file ("correctly"). Last time I hacked into the minified file in order to test the stuff.

[brendo]

Actually that's a good point, @nilshoerrmann @nitriques are we able to write up a few lines about how to install/recompile the minified assets and add them to the Contributing guide?

@animaux It's done using grunt, but I'm not super familiar with the full steps to get grunt installed. I think it's just a npm install from the root directory (to get the dependencies) and then run grunt to actually perform the tasks.

[michael-e]

Once again I hacked the minified file. I replaced .split(",").join("\\,") with .replace(/,/g, '\\,').replace(/&/g, '%26'), and it worked fine. So we should be fine with @brendo's code!

[jonmifsud]

@brendo those should be the steps. I've set it up to do some modifications before.

[animaux]

@michael-e I’m not able to find .split(",").join("\\,") in my symphony.min.js. Symphony 2.6.2 master. Are you in the integration branch?

[michael-e]

No, I am on Symphony 2.6.2. I can find the string. Which editor do you have?

[animaux]

BBEdit 11.1

[animaux]

m( d’oh: hadn’t reloaded the file in the editor after the 2.6.2 update … found it.

[nilshoerrmann]

Actually that's a good point, @nilshoerrmann @nitriques are we able to write up a few lines about how to install/recompile the minified assets and add them to the Contributing guide?

@nitriques might be better at this job :)

[animaux]

Work’s fine for me! Tested with:

• Regular Characters + Spaces
• Ampersand
• Umlaut (ä, ö, ü)
• Comma

Cheers!

[nitriques]

@brendo @nilshoerrmann
Sorry it took so long, but, here it is: https://github.com/symphonycms/symphony-2/wiki/Building-the-client-assets-files

I've also added a link to it on the home page.

Is it missing something ?

[brendo]

Pushed the fix for real :)

[michael-e]

The page is completely gone: https://github.com/symphonycms/symphony-2/wiki/Building-the-client-assets-files

I know it was there, I saw it. How can that be?

[michael-e]

Re: The fix: Confirmed that it works as advertised. ( @animaux )

[brendo]

Sorry, that was me, I thought Github pages did automatic redirects, https://github.com/symphonycms/symphony-2/wiki/Building-Symphony%27s-Assets

[michael-e]

Ah, thanks!

[nitriques]

Oh sorry for the typo!

And is the doc ok ?

[michael-e]

Yeah, sure! I just had to do install grunt-cli as well (npm install -g grunt-cli) in order to make it work for me.

[nitriques]

Totally true. It's not grunt that you need to install globally, it's the cli.

I will update the doc accordingly. Thanks

[animaux]

@michael-e Prima, thanks! :)

[michael-e]

You're welcome.