InputMask: slotChar as optional

[cfortes]

InputMask: slotChar as optional

[cfortes]

@melloware oh yes this version I also tested and it is working fine!

[melloware]

In PrimeFacess 6.1 it used the dead and deprecated jquery.mask.js plugin. It was upgraded to the modern InputMask plugin with this one: #6062

The newer InputMask is kept up to date, had way more features and bugfixes as you can see that PR closed 4 previous issues.

But let me revisit this to see what can be done as you have seen from this issue which is why we strip the optional "slotChar" #6469

[melloware]

Cc @tuerker who originally requested the fix that you mentioned above.

[cfortes]

Awesome, thank you! I can see many scenarios where removing the slotChar from the incomplete masked input value would be the right move and why it was implemented this way. But as I mentioned there are some cases where keeping the optional slotChar had some usefulness. Thats why I suggested that it should be interesting to have an option for both solutions.

[melloware]

@cfortes thanks for the report. Also do you need a workaround for 13.x to get this working the way it was? I can provide one if you don't have one you are already using?

[cfortes]

Yes I'd like a workaround! I've been trying to find one but nothing really works

[melloware]

Ok I will post here tomorrow how you can make it work.

[melloware]

@cfortes give this a try just unzip and run mvn clean jetty:run and go to http://localhost:8080/
pf-11958.zip

basically i override the renderer to only strip out the slotChar IF you are using an "optional" mask.

public class SlotCharInputMaskRenderer extends InputMaskRenderer {

    @Override
    public void decode(FacesContext context, UIComponent component) {
        InputMask inputMask = (InputMask) component;

        if (!shouldDecode(inputMask)) {
            return;
        }

        decodeBehaviors(context, inputMask);

        String clientId = inputMask.getClientId(context);
        String submittedValue = context.getExternalContext().getRequestParameterMap().get(clientId);

        if (submittedValue != null) {
            // strip mask characters in case of optional values
            String mask = inputMask.getMask();
            if (mask.contains("[") || mask.contains("]")) {
                submittedValue = submittedValue.replace(inputMask.getSlotChar(), Constants.EMPTY_STRING);
            }
            
            if (inputMask.isValidateMask() && !LangUtils.isEmpty(submittedValue) && LangUtils.isNotBlank(mask)) {
                Pattern pattern = translateMaskIntoRegex(context, mask);
                if (!pattern.matcher(submittedValue).matches()) {
                    submittedValue = Constants.EMPTY_STRING;
                }
            }

            inputMask.setSubmittedValue(submittedValue);
        }
    }
    
}

[cfortes]

@melloware thank you it worked!
I only have one question, is it ok to force autoClear = false when there is optional mask? #11959
I'm asking because isn't there a possibility of the user input an invalid value and it won't be cleared when the mask is optional?

[melloware]

So in the renderer we do this...

// autoclear must be false when using optional mask
            boolean autoClear = inputMask.isAutoClear();
            if (mask.contains("[") || mask.contains("]")) {
                autoClear = false;
            }

Basically if you are using optional mask it automatically sets AutoClear="false".

Do you think that is still OK?

[cfortes]

@melloware I've done the following test:

<p:inputMask 
    value="#{exampleController.value}"
    mask="(99) 9999[9]-9999"
    autoClear="true">
</p:inputMask>

• the mask "(99) 9999[9]-9999" is used for phone numbers, and its value has an optional extra digit
• I've inputed "000" an incomplete and invalid value. it has been validated correctly, it has been recognized as invalid and sent null to the server
• but it kept the incorrect value on the screen

[melloware]

did you try it with validateMask="false"? The optionals make server side prevention tough. In 6.1 we were not defending the security of someone just doing a FORM POST and sending you an invalid value for a mask so we prevent invalid submissions.

[melloware]

Also I just tested and mine is not keeping the incorrect version on the screen?

pf-11958-2.zip