File: RedactingCursor.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 326,092 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,181; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 117; sed: 19
file content (181 lines) | stat: -rw-r--r-- 5,544 bytes parent folder | download | duplicates (4)
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/*
 * Copyright (C) 2018 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.database;

import android.annotation.NonNull;
import android.util.SparseArray;

import java.util.Map;

/**
 * Cursor that offers to redact values of requested columns.
 *
 * @hide
 */
public class RedactingCursor extends CrossProcessCursorWrapper {
    private final SparseArray<Object> mRedactions;

    private RedactingCursor(@NonNull Cursor cursor, SparseArray<Object> redactions) {
        super(cursor);
        mRedactions = redactions;
    }

    /**
     * Create a wrapped instance of the given {@link Cursor} which redacts the
     * requested columns so they always return specific values when accessed.
     * <p>
     * If a redacted column appears multiple times in the underlying cursor, all
     * instances will be redacted. If none of the redacted columns appear in the
     * given cursor, the given cursor will be returned untouched to improve
     * performance.
     */
    public static Cursor create(@NonNull Cursor cursor, @NonNull Map<String, Object> redactions) {
        final SparseArray<Object> internalRedactions = new SparseArray<>();

        final String[] columns = cursor.getColumnNames();
        for (int i = 0; i < columns.length; i++) {
            if (redactions.containsKey(columns[i])) {
                internalRedactions.put(i, redactions.get(columns[i]));
            }
        }

        if (internalRedactions.size() == 0) {
            return cursor;
        } else {
            return new RedactingCursor(cursor, internalRedactions);
        }
    }

    @Override
    public void fillWindow(int position, CursorWindow window) {
        // Fill window directly to ensure data is redacted
        DatabaseUtils.cursorFillWindow(this, position, window);
    }

    @Override
    public CursorWindow getWindow() {
        // Returning underlying window risks leaking redacted data
        return null;
    }

    @Override
    public Cursor getWrappedCursor() {
        throw new UnsupportedOperationException(
                "Returning underlying cursor risks leaking redacted data");
    }

    @Override
    public double getDouble(int columnIndex) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            return (double) mRedactions.valueAt(i);
        } else {
            return super.getDouble(columnIndex);
        }
    }

    @Override
    public float getFloat(int columnIndex) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            return (float) mRedactions.valueAt(i);
        } else {
            return super.getFloat(columnIndex);
        }
    }

    @Override
    public int getInt(int columnIndex) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            return (int) mRedactions.valueAt(i);
        } else {
            return super.getInt(columnIndex);
        }
    }

    @Override
    public long getLong(int columnIndex) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            return (long) mRedactions.valueAt(i);
        } else {
            return super.getLong(columnIndex);
        }
    }

    @Override
    public short getShort(int columnIndex) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            return (short) mRedactions.valueAt(i);
        } else {
            return super.getShort(columnIndex);
        }
    }

    @Override
    public String getString(int columnIndex) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            return (String) mRedactions.valueAt(i);
        } else {
            return super.getString(columnIndex);
        }
    }

    @Override
    public void copyStringToBuffer(int columnIndex, CharArrayBuffer buffer) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            buffer.data = ((String) mRedactions.valueAt(i)).toCharArray();
            buffer.sizeCopied = buffer.data.length;
        } else {
            super.copyStringToBuffer(columnIndex, buffer);
        }
    }

    @Override
    public byte[] getBlob(int columnIndex) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            return (byte[]) mRedactions.valueAt(i);
        } else {
            return super.getBlob(columnIndex);
        }
    }

    @Override
    public int getType(int columnIndex) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            return DatabaseUtils.getTypeOfObject(mRedactions.valueAt(i));
        } else {
            return super.getType(columnIndex);
        }
    }

    @Override
    public boolean isNull(int columnIndex) {
        final int i = mRedactions.indexOfKey(columnIndex);
        if (i >= 0) {
            return mRedactions.valueAt(i) == null;
        } else {
            return super.isNull(columnIndex);
        }
    }
}