File: TextValueSanitizer.java

package info (click to toggle)
android-platform-frameworks-base 1%3A10.0.0%2Br36-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 321,788 kB
  • sloc: java: 962,234; cpp: 274,314; xml: 242,770; python: 5,060; sh: 1,432; ansic: 494; makefile: 47; sed: 19
file content (131 lines) | stat: -rw-r--r-- 4,376 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.service.autofill;

import static android.view.autofill.Helper.sDebug;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.TestApi;
import android.os.Parcel;
import android.os.Parcelable;
import android.util.Slog;
import android.view.autofill.AutofillValue;

import com.android.internal.util.Preconditions;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Sanitizes a text {@link AutofillValue} using a regular expression (regex) substitution.
 *
 * <p>For example, to remove spaces from groups of 4-digits in a credit card:
 *
 * <pre class="prettyprint">
 * new TextValueSanitizer(Pattern.compile("^(\\d{4})\\s?(\\d{4})\\s?(\\d{4})\\s?(\\d{4})$"),
 *     "$1$2$3$4")
 * </pre>
 */
public final class TextValueSanitizer extends InternalSanitizer implements
        Sanitizer, Parcelable {
    private static final String TAG = "TextValueSanitizer";

    private final Pattern mRegex;
    private final String mSubst;

    /**
     * Default constructor.
     *
     * @param regex regular expression with groups (delimited by {@code (} and {@code (}) that
     * are used to substitute parts of the {@link AutofillValue#getTextValue() text value}.
     * @param subst the string that substitutes the matched regex, using {@code $} for
     * group substitution ({@code $1} for 1st group match, {@code $2} for 2nd, etc).
     */
    public TextValueSanitizer(@NonNull Pattern regex, @NonNull String subst) {
        mRegex = Preconditions.checkNotNull(regex);
        mSubst = Preconditions.checkNotNull(subst);
    }

    /** @hide */
    @Override
    @TestApi
    @Nullable
    public AutofillValue sanitize(@NonNull AutofillValue value) {
        if (value == null) {
            Slog.w(TAG, "sanitize() called with null value");
            return null;
        }
        if (!value.isText()) {
            if (sDebug) Slog.d(TAG, "sanitize() called with non-text value: " + value);
            return null;
        }

        final CharSequence text = value.getTextValue();

        try {
            final Matcher matcher = mRegex.matcher(text);
            if (!matcher.matches()) {
                if (sDebug) Slog.d(TAG, "sanitize(): " + mRegex + " failed for " + value);
                return null;
            }

            final CharSequence sanitized = matcher.replaceAll(mSubst);
            return AutofillValue.forText(sanitized);
        } catch (Exception e) {
            Slog.w(TAG, "Exception evaluating " + mRegex + "/" + mSubst + ": " + e);
            return null;
        }
    }

    /////////////////////////////////////
    // Object "contract" methods. //
    /////////////////////////////////////
    @Override
    public String toString() {
        if (!sDebug) return super.toString();

        return "TextValueSanitizer: [regex=" + mRegex + ", subst=" + mSubst + "]";
    }

    /////////////////////////////////////
    // Parcelable "contract" methods. //
    /////////////////////////////////////
    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(Parcel parcel, int flags) {
        parcel.writeSerializable(mRegex);
        parcel.writeString(mSubst);
    }

    public static final @android.annotation.NonNull Parcelable.Creator<TextValueSanitizer> CREATOR =
            new Parcelable.Creator<TextValueSanitizer>() {
        @Override
        public TextValueSanitizer createFromParcel(Parcel parcel) {
            return new TextValueSanitizer((Pattern) parcel.readSerializable(), parcel.readString());
        }

        @Override
        public TextValueSanitizer[] newArray(int size) {
            return new TextValueSanitizer[size];
        }
    };
}