-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Expand file tree
/
Copy pathvalidation.ts
More file actions
224 lines (189 loc) · 9.7 KB
/
Copy pathvalidation.ts
File metadata and controls
224 lines (189 loc) · 9.7 KB
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
import {DEFAULT_SETTINGS, DEFAULT_THEME} from '../defaults';
import type {UserSettings, Theme, ThemePreset, CustomSiteConfig, TimeSettings, LocationSettings, Automation} from '../definitions';
import {AutomationMode} from './automation';
function isBoolean(x: any): x is boolean {
return typeof x === 'boolean';
}
function isPlainObject(x: any): x is Record<string, unknown> {
return typeof x === 'object' && x != null && !Array.isArray(x);
}
function isArray(x: any) {
return Array.isArray(x);
}
function isString(x: any): x is string {
return typeof x === 'string';
}
function isNonEmptyString(x: any): x is string {
return x && isString(x);
}
function isNonEmptyArrayOfNonEmptyStrings(x: any): x is any[] {
return Array.isArray(x) && x.length > 0 && x.every((s) => isNonEmptyString(s));
}
function isRegExpMatch(regexp: RegExp) {
return (x: any): x is string => {
return isString(x) && x.match(regexp) != null;
};
}
const isTime = isRegExpMatch(/^((0?[0-9])|(1[0-9])|(2[0-3])):([0-5][0-9])$/);
function isNumber(x: any): x is number {
return typeof x === 'number' && !isNaN(x);
}
function isNumberBetween(min: number, max: number) {
return (x: any): x is number => {
return isNumber(x) && x >= min && x <= max;
};
}
function isOneOf(...values: any[]) {
return (x: any) => values.includes(x);
}
function hasRequiredProperties<T extends Record<string, unknown>>(obj: T, keys: Array<keyof T>) {
return keys.every((key) => obj.hasOwnProperty(key));
}
function createValidator() {
const errors: string[] = [];
function validateProperty<T extends Record<string, unknown>>(obj: T, key: keyof T, validator: (x: any) => boolean, fallback: T) {
if (!obj.hasOwnProperty(key) || validator(obj[key])) {
return;
}
errors.push(`Unexpected value for "${key as string}": ${JSON.stringify(obj[key])}`);
obj[key] = fallback[key];
}
function validateArray<T extends Record<string, unknown>, V>(obj: T, key: keyof T, validator: (x: V) => boolean) {
if (!obj.hasOwnProperty(key)) {
return;
}
const wrongValues = new Set();
const arr: any[] = obj[key] as any;
for (let i = 0; i < arr.length; i++) {
if (!validator(arr[i])) {
wrongValues.add(arr[i]);
arr.splice(i, 1);
i--;
}
}
if (wrongValues.size > 0) {
errors.push(`Array "${key as string}" has wrong values: ${Array.from(wrongValues).map((v) => JSON.stringify(v)).join('; ')}`);
}
}
return {validateProperty, validateArray, errors};
}
interface SettingValidationResult {
settings: Partial<UserSettings>;
errors: string[];
}
export function validateSettings(settings: Partial<UserSettings>): SettingValidationResult {
if (!isPlainObject(settings)) {
return {errors: ['Settings are not a plain object'], settings: DEFAULT_SETTINGS};
}
const {validateProperty, validateArray, errors} = createValidator();
const isValidPresetTheme = (theme: Theme) => {
if (!isPlainObject(theme)) {
return false;
}
const {errors: themeErrors} = validateTheme(theme);
return themeErrors.length === 0;
};
validateProperty(settings, 'schemeVersion', isNumber, DEFAULT_SETTINGS);
validateProperty(settings, 'enabled', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'fetchNews', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'theme', isPlainObject, DEFAULT_SETTINGS);
const {errors: themeErrors} = validateTheme(settings.theme);
errors.push(...themeErrors);
validateProperty(settings, 'presets', isArray, DEFAULT_SETTINGS);
validateArray(settings, 'presets', (preset: ThemePreset) => {
const presetValidator = createValidator();
if (!(isPlainObject(preset) && hasRequiredProperties(preset, ['id', 'name', 'urls', 'theme']))) {
return false;
}
presetValidator.validateProperty(preset, 'id', isNonEmptyString, preset);
presetValidator.validateProperty(preset, 'name', isNonEmptyString, preset);
presetValidator.validateProperty(preset, 'urls', isNonEmptyArrayOfNonEmptyStrings, preset);
presetValidator.validateProperty(preset, 'theme', isValidPresetTheme, preset);
return presetValidator.errors.length === 0;
});
validateProperty(settings, 'customThemes', isArray, DEFAULT_SETTINGS);
validateArray(settings, 'customThemes', (custom: CustomSiteConfig) => {
if (!(isPlainObject(custom) && hasRequiredProperties(custom, ['url', 'theme']))) {
return false;
}
const presetValidator = createValidator();
presetValidator.validateProperty(custom, 'url', isNonEmptyArrayOfNonEmptyStrings, custom);
presetValidator.validateProperty(custom, 'theme', isValidPresetTheme, custom);
return presetValidator.errors.length === 0;
});
validateProperty(settings, 'enabledFor', isArray, DEFAULT_SETTINGS);
validateArray(settings, 'enabledFor', isNonEmptyString);
validateProperty(settings, 'disabledFor', isArray, DEFAULT_SETTINGS);
validateArray(settings, 'disabledFor', isNonEmptyString);
validateProperty(settings, 'enabledByDefault', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'changeBrowserTheme', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'syncSettings', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'syncSitesFixes', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'automation', (automation: Automation) => {
if (!isPlainObject(automation)) {
return false;
}
const automationValidator = createValidator();
automationValidator.validateProperty(automation, 'enabled', isBoolean, automation);
automationValidator.validateProperty(automation, 'mode', isOneOf(AutomationMode.SYSTEM, AutomationMode.TIME, AutomationMode.LOCATION, AutomationMode.NONE), automation);
automationValidator.validateProperty(automation, 'behavior', isOneOf('OnOff', 'Scheme'), automation);
return automationValidator.errors.length === 0;
}, DEFAULT_SETTINGS);
validateProperty(settings, AutomationMode.TIME, (time: TimeSettings) => {
if (!isPlainObject(time)) {
return false;
}
const timeValidator = createValidator();
timeValidator.validateProperty(time, 'activation', isTime, time);
timeValidator.validateProperty(time, 'deactivation', isTime, time);
return timeValidator.errors.length === 0;
}, DEFAULT_SETTINGS);
validateProperty(settings, AutomationMode.LOCATION, (location: LocationSettings) => {
if (!isPlainObject(location)) {
return false;
}
const locValidator = createValidator();
const isValidLoc = (x: any) => x === null || isNumber(x);
locValidator.validateProperty(location, 'latitude', isValidLoc, location);
locValidator.validateProperty(location, 'longitude', isValidLoc, location);
return locValidator.errors.length === 0;
}, DEFAULT_SETTINGS);
validateProperty(settings, 'previewNewDesign', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'previewNewestDesign', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'enableForPDF', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'enableForProtectedPages', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'enableContextMenus', isBoolean, DEFAULT_SETTINGS);
validateProperty(settings, 'detectDarkTheme', isBoolean, DEFAULT_SETTINGS);
return {errors, settings};
}
interface ThemeValidationResult {
theme: Partial<Theme>;
errors: string[];
}
export function validateTheme(theme: Partial<Theme> | null | undefined): ThemeValidationResult {
if (!isPlainObject(theme)) {
return {errors: ['Theme is not a plain object'], theme: DEFAULT_THEME};
}
const {validateProperty, errors} = createValidator();
validateProperty(theme, 'mode', isOneOf(0, 1), DEFAULT_THEME);
validateProperty(theme, 'brightness', isNumberBetween(0, 200), DEFAULT_THEME);
validateProperty(theme, 'contrast', isNumberBetween(0, 200), DEFAULT_THEME);
validateProperty(theme, 'grayscale', isNumberBetween(0, 100), DEFAULT_THEME);
validateProperty(theme, 'sepia', isNumberBetween(0, 100), DEFAULT_THEME);
validateProperty(theme, 'useFont', isBoolean, DEFAULT_THEME);
validateProperty(theme, 'fontFamily', isNonEmptyString, DEFAULT_THEME);
validateProperty(theme, 'textStroke', isNumberBetween(0, 1), DEFAULT_THEME);
validateProperty(theme, 'engine', isOneOf('dynamicTheme', 'staticTheme', 'cssFilter', 'svgFilter'), DEFAULT_THEME);
validateProperty(theme, 'stylesheet', isString, DEFAULT_THEME);
validateProperty(theme, 'darkSchemeBackgroundColor', isRegExpMatch(/^#[0-9a-f]{6}$/i), DEFAULT_THEME);
validateProperty(theme, 'darkSchemeTextColor', isRegExpMatch(/^#[0-9a-f]{6}$/i), DEFAULT_THEME);
validateProperty(theme, 'lightSchemeBackgroundColor', isRegExpMatch(/^#[0-9a-f]{6}$/i), DEFAULT_THEME);
validateProperty(theme, 'lightSchemeTextColor', isRegExpMatch(/^#[0-9a-f]{6}$/i), DEFAULT_THEME);
validateProperty(theme, 'scrollbarColor', (x: any) => x === '' || isRegExpMatch(/^(auto)|(#[0-9a-f]{6})$/i)(x), DEFAULT_THEME);
validateProperty(theme, 'selectionColor', isRegExpMatch(/^(auto)|(#[0-9a-f]{6})$/i), DEFAULT_THEME);
validateProperty(theme, 'styleSystemControls', isBoolean, DEFAULT_THEME);
validateProperty(theme, 'lightColorScheme', isNonEmptyString, DEFAULT_THEME);
validateProperty(theme, 'darkColorScheme', isNonEmptyString, DEFAULT_THEME);
validateProperty(theme, 'immediateModify', isBoolean, DEFAULT_THEME);
return {errors, theme};
}