123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724 |
- 'use strict';
- const Net = require('net');
- const Address = require('@hapi/address');
- const Hoek = require('@hapi/hoek');
- const Any = require('../any');
- const Ref = require('../../ref');
- const JoiDate = require('../date');
- const Uri = require('./uri');
- const Ip = require('./ip');
- const internals = {
- uriRegex: Uri.createUriRegex(),
- ipRegex: Ip.createIpRegex(['ipv4', 'ipv6', 'ipvfuture'], 'optional'),
- guidBrackets: {
- '{': '}', '[': ']', '(': ')', '': ''
- },
- guidVersions: {
- uuidv1: '1',
- uuidv2: '2',
- uuidv3: '3',
- uuidv4: '4',
- uuidv5: '5'
- },
- cidrPresences: ['required', 'optional', 'forbidden'],
- normalizationForms: ['NFC', 'NFD', 'NFKC', 'NFKD']
- };
- internals.String = class extends Any {
- constructor() {
- super();
- this._type = 'string';
- this._invalids.add('');
- }
- _base(value, state, options) {
- if (typeof value === 'string' &&
- options.convert) {
- if (this._flags.normalize) {
- value = value.normalize(this._flags.normalize);
- }
- if (this._flags.case) {
- value = (this._flags.case === 'upper' ? value.toLocaleUpperCase() : value.toLocaleLowerCase());
- }
- if (this._flags.trim) {
- value = value.trim();
- }
- if (this._inner.replacements) {
- for (let i = 0; i < this._inner.replacements.length; ++i) {
- const replacement = this._inner.replacements[i];
- value = value.replace(replacement.pattern, replacement.replacement);
- }
- }
- if (this._flags.truncate) {
- for (let i = 0; i < this._tests.length; ++i) {
- const test = this._tests[i];
- if (test.name === 'max') {
- value = value.slice(0, test.arg);
- break;
- }
- }
- }
- if (this._flags.byteAligned && value.length % 2 !== 0) {
- value = `0${value}`;
- }
- }
- return {
- value,
- errors: (typeof value === 'string') ? null : this.createError('string.base', { value }, state, options)
- };
- }
- insensitive() {
- if (this._flags.insensitive) {
- return this;
- }
- const obj = this.clone();
- obj._flags.insensitive = true;
- return obj;
- }
- creditCard() {
- return this._test('creditCard', undefined, function (value, state, options) {
- let i = value.length;
- let sum = 0;
- let mul = 1;
- while (i--) {
- const char = value.charAt(i) * mul;
- sum = sum + (char - (char > 9) * 9);
- mul = mul ^ 3;
- }
- const check = (sum % 10 === 0) && (sum > 0);
- return check ? value : this.createError('string.creditCard', { value }, state, options);
- });
- }
- regex(pattern, patternOptions) {
- Hoek.assert(pattern instanceof RegExp, 'pattern must be a RegExp');
- Hoek.assert(!pattern.flags.includes('g') && !pattern.flags.includes('y'), 'pattern should not use global or sticky mode');
- const patternObject = { pattern };
- if (typeof patternOptions === 'string') {
- patternObject.name = patternOptions;
- }
- else if (typeof patternOptions === 'object') {
- patternObject.invert = !!patternOptions.invert;
- if (patternOptions.name) {
- patternObject.name = patternOptions.name;
- }
- }
- const errorCode = ['string.regex', patternObject.invert ? '.invert' : '', patternObject.name ? '.name' : '.base'].join('');
- return this._test('regex', patternObject, function (value, state, options) {
- const patternMatch = patternObject.pattern.test(value);
- if (patternMatch ^ patternObject.invert) {
- return value;
- }
- return this.createError(errorCode, { name: patternObject.name, pattern: patternObject.pattern, value }, state, options);
- });
- }
- alphanum() {
- return this._test('alphanum', undefined, function (value, state, options) {
- if (/^[a-zA-Z0-9]+$/.test(value)) {
- return value;
- }
- return this.createError('string.alphanum', { value }, state, options);
- });
- }
- token() {
- return this._test('token', undefined, function (value, state, options) {
- if (/^\w+$/.test(value)) {
- return value;
- }
- return this.createError('string.token', { value }, state, options);
- });
- }
- email(validationOptions) {
- if (validationOptions) {
- Hoek.assert(typeof validationOptions === 'object', 'email options must be an object');
- // Migration validation for unsupported options
- Hoek.assert(validationOptions.checkDNS === undefined, 'checkDNS option is not supported');
- Hoek.assert(validationOptions.errorLevel === undefined, 'errorLevel option is not supported');
- Hoek.assert(validationOptions.minDomainAtoms === undefined, 'minDomainAtoms option is not supported, use minDomainSegments instead');
- Hoek.assert(validationOptions.tldBlacklist === undefined, 'tldBlacklist option is not supported, use tlds.deny instead');
- Hoek.assert(validationOptions.tldWhitelist === undefined, 'tldWhitelist option is not supported, use tlds.allow instead');
- // Validate options
- if (validationOptions.tlds &&
- typeof validationOptions.tlds === 'object') {
- Hoek.assert(validationOptions.tlds.allow === undefined ||
- validationOptions.tlds.allow === false ||
- validationOptions.tlds.allow === true ||
- Array.isArray(validationOptions.tlds.allow) ||
- validationOptions.tlds.allow instanceof Set, 'tlds.allow must be an array, Set, or boolean');
- Hoek.assert(validationOptions.tlds.deny === undefined ||
- Array.isArray(validationOptions.tlds.deny) ||
- validationOptions.tlds.deny instanceof Set, 'tlds.deny must be an array or Set');
- const normalizeTable = (table) => {
- if (table === undefined ||
- typeof table === 'boolean' ||
- table instanceof Set) {
- return table;
- }
- return new Set(table);
- };
- validationOptions = Object.assign({}, validationOptions); // Shallow cloned
- validationOptions.tlds = {
- allow: normalizeTable(validationOptions.tlds.allow),
- deny: normalizeTable(validationOptions.tlds.deny)
- };
- }
- Hoek.assert(validationOptions.minDomainSegments === undefined ||
- Number.isSafeInteger(validationOptions.minDomainSegments) && validationOptions.minDomainSegments > 0, 'minDomainSegments must be a positive integer');
- }
- return this._test('email', validationOptions, function (value, state, options) {
- if (Address.email.isValid(value, validationOptions)) {
- return value;
- }
- return this.createError('string.email', { value }, state, options);
- });
- }
- ip(ipOptions = {}) {
- let regex = internals.ipRegex;
- Hoek.assert(typeof ipOptions === 'object', 'options must be an object');
- if (ipOptions.cidr) {
- Hoek.assert(typeof ipOptions.cidr === 'string', 'cidr must be a string');
- ipOptions.cidr = ipOptions.cidr.toLowerCase();
- Hoek.assert(Hoek.contain(internals.cidrPresences, ipOptions.cidr), 'cidr must be one of ' + internals.cidrPresences.join(', '));
- // If we only received a `cidr` setting, create a regex for it. But we don't need to create one if `cidr` is "optional" since that is the default
- if (!ipOptions.version && ipOptions.cidr !== 'optional') {
- regex = Ip.createIpRegex(['ipv4', 'ipv6', 'ipvfuture'], ipOptions.cidr);
- }
- }
- else {
- // Set our default cidr strategy
- ipOptions.cidr = 'optional';
- }
- let versions;
- if (ipOptions.version) {
- if (!Array.isArray(ipOptions.version)) {
- ipOptions.version = [ipOptions.version];
- }
- Hoek.assert(ipOptions.version.length >= 1, 'version must have at least 1 version specified');
- versions = [];
- for (let i = 0; i < ipOptions.version.length; ++i) {
- let version = ipOptions.version[i];
- Hoek.assert(typeof version === 'string', 'version at position ' + i + ' must be a string');
- version = version.toLowerCase();
- Hoek.assert(Ip.versions[version], 'version at position ' + i + ' must be one of ' + Object.keys(Ip.versions).join(', '));
- versions.push(version);
- }
- // Make sure we have a set of versions
- versions = Array.from(new Set(versions));
- regex = Ip.createIpRegex(versions, ipOptions.cidr);
- }
- return this._test('ip', ipOptions, function (value, state, options) {
- if (regex.test(value)) {
- return value;
- }
- if (versions) {
- return this.createError('string.ipVersion', { value, cidr: ipOptions.cidr, version: versions }, state, options);
- }
- return this.createError('string.ip', { value, cidr: ipOptions.cidr }, state, options);
- });
- }
- uri(uriOptions) {
- let customScheme = '';
- let allowRelative = false;
- let relativeOnly = false;
- let allowQuerySquareBrackets = false;
- let regex = internals.uriRegex;
- if (uriOptions) {
- Hoek.assert(typeof uriOptions === 'object', 'options must be an object');
- const unknownOptions = Object.keys(uriOptions).filter((key) => !['scheme', 'allowRelative', 'relativeOnly', 'allowQuerySquareBrackets'].includes(key));
- Hoek.assert(unknownOptions.length === 0, `options contain unknown keys: ${unknownOptions}`);
- if (uriOptions.scheme) {
- Hoek.assert(uriOptions.scheme instanceof RegExp || typeof uriOptions.scheme === 'string' || Array.isArray(uriOptions.scheme), 'scheme must be a RegExp, String, or Array');
- if (!Array.isArray(uriOptions.scheme)) {
- uriOptions.scheme = [uriOptions.scheme];
- }
- Hoek.assert(uriOptions.scheme.length >= 1, 'scheme must have at least 1 scheme specified');
- // Flatten the array into a string to be used to match the schemes.
- for (let i = 0; i < uriOptions.scheme.length; ++i) {
- const scheme = uriOptions.scheme[i];
- Hoek.assert(scheme instanceof RegExp || typeof scheme === 'string', 'scheme at position ' + i + ' must be a RegExp or String');
- // Add OR separators if a value already exists
- customScheme = customScheme + (customScheme ? '|' : '');
- // If someone wants to match HTTP or HTTPS for example then we need to support both RegExp and String so we don't escape their pattern unknowingly.
- if (scheme instanceof RegExp) {
- customScheme = customScheme + scheme.source;
- }
- else {
- Hoek.assert(/[a-zA-Z][a-zA-Z0-9+-\.]*/.test(scheme), 'scheme at position ' + i + ' must be a valid scheme');
- customScheme = customScheme + Hoek.escapeRegex(scheme);
- }
- }
- }
- if (uriOptions.allowRelative) {
- allowRelative = true;
- }
- if (uriOptions.relativeOnly) {
- relativeOnly = true;
- }
- if (uriOptions.allowQuerySquareBrackets) {
- allowQuerySquareBrackets = true;
- }
- }
- if (customScheme || allowRelative || relativeOnly || allowQuerySquareBrackets) {
- regex = Uri.createUriRegex(customScheme, allowRelative, relativeOnly, allowQuerySquareBrackets);
- }
- return this._test('uri', uriOptions, function (value, state, options) {
- if (regex.test(value)) {
- return value;
- }
- if (relativeOnly) {
- return this.createError('string.uriRelativeOnly', { value }, state, options);
- }
- if (customScheme) {
- return this.createError('string.uriCustomScheme', { scheme: customScheme, value }, state, options);
- }
- return this.createError('string.uri', { value }, state, options);
- });
- }
- isoDate() {
- return this._test('isoDate', undefined, function (value, state, options) {
- if (JoiDate._isIsoDate(value)) {
- if (!options.convert) {
- return value;
- }
- const d = new Date(value);
- if (!isNaN(d.getTime())) {
- return d.toISOString();
- }
- }
- return this.createError('string.isoDate', { value }, state, options);
- });
- }
- guid(guidOptions) {
- let versionNumbers = '';
- if (guidOptions && guidOptions.version) {
- if (!Array.isArray(guidOptions.version)) {
- guidOptions.version = [guidOptions.version];
- }
- Hoek.assert(guidOptions.version.length >= 1, 'version must have at least 1 valid version specified');
- const versions = new Set();
- for (let i = 0; i < guidOptions.version.length; ++i) {
- let version = guidOptions.version[i];
- Hoek.assert(typeof version === 'string', 'version at position ' + i + ' must be a string');
- version = version.toLowerCase();
- const versionNumber = internals.guidVersions[version];
- Hoek.assert(versionNumber, 'version at position ' + i + ' must be one of ' + Object.keys(internals.guidVersions).join(', '));
- Hoek.assert(!(versions.has(versionNumber)), 'version at position ' + i + ' must not be a duplicate.');
- versionNumbers += versionNumber;
- versions.add(versionNumber);
- }
- }
- const guidRegex = new RegExp(`^([\\[{\\(]?)[0-9A-F]{8}([:-]?)[0-9A-F]{4}\\2?[${versionNumbers || '0-9A-F'}][0-9A-F]{3}\\2?[${versionNumbers ? '89AB' : '0-9A-F'}][0-9A-F]{3}\\2?[0-9A-F]{12}([\\]}\\)]?)$`, 'i');
- return this._test('guid', guidOptions, function (value, state, options) {
- const results = guidRegex.exec(value);
- if (!results) {
- return this.createError('string.guid', { value }, state, options);
- }
- // Matching braces
- if (internals.guidBrackets[results[1]] !== results[results.length - 1]) {
- return this.createError('string.guid', { value }, state, options);
- }
- return value;
- });
- }
- hex(hexOptions = {}) {
- Hoek.assert(typeof hexOptions === 'object', 'hex options must be an object');
- Hoek.assert(typeof hexOptions.byteAligned === 'undefined' || typeof hexOptions.byteAligned === 'boolean',
- 'byteAligned must be boolean');
- const byteAligned = hexOptions.byteAligned === true;
- const regex = /^[a-f0-9]+$/i;
- const obj = this._test('hex', regex, function (value, state, options) {
- if (regex.test(value)) {
- if (byteAligned && value.length % 2 !== 0) {
- return this.createError('string.hexAlign', { value }, state, options);
- }
- return value;
- }
- return this.createError('string.hex', { value }, state, options);
- });
- if (byteAligned) {
- obj._flags.byteAligned = true;
- }
- return obj;
- }
- base64(base64Options = {}) {
- // Validation.
- Hoek.assert(typeof base64Options === 'object', 'base64 options must be an object');
- Hoek.assert(typeof base64Options.paddingRequired === 'undefined' || typeof base64Options.paddingRequired === 'boolean',
- 'paddingRequired must be boolean');
- // Determine if padding is required.
- const paddingRequired = base64Options.paddingRequired === false ?
- base64Options.paddingRequired
- : base64Options.paddingRequired || true;
- // Set validation based on preference.
- const regex = paddingRequired ?
- // Padding is required.
- /^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
- // Padding is optional.
- : /^(?:[A-Za-z0-9+\/]{2}[A-Za-z0-9+\/]{2})*(?:[A-Za-z0-9+\/]{2}(==)?|[A-Za-z0-9+\/]{3}=?)?$/;
- return this._test('base64', regex, function (value, state, options) {
- if (regex.test(value)) {
- return value;
- }
- return this.createError('string.base64', { value }, state, options);
- });
- }
- dataUri(dataUriOptions = {}) {
- const regex = /^data:[\w+.-]+\/[\w+.-]+;((charset=[\w-]+|base64),)?(.*)$/;
- // Determine if padding is required.
- const paddingRequired = dataUriOptions.paddingRequired === false ?
- dataUriOptions.paddingRequired
- : dataUriOptions.paddingRequired || true;
- const base64regex = paddingRequired ?
- /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
- : /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}(==)?|[A-Za-z0-9+\/]{3}=?)?$/;
- return this._test('dataUri', regex, function (value, state, options) {
- const matches = value.match(regex);
- if (matches) {
- if (!matches[2]) {
- return value;
- }
- if (matches[2] !== 'base64') {
- return value;
- }
- if (base64regex.test(matches[3])) {
- return value;
- }
- }
- return this.createError('string.dataUri', { value }, state, options);
- });
- }
- hostname() {
- const regex = /^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/;
- return this._test('hostname', undefined, function (value, state, options) {
- if ((value.length <= 255 && regex.test(value)) ||
- Net.isIPv6(value)) {
- return value;
- }
- return this.createError('string.hostname', { value }, state, options);
- });
- }
- normalize(form = 'NFC') {
- Hoek.assert(Hoek.contain(internals.normalizationForms, form), 'normalization form must be one of ' + internals.normalizationForms.join(', '));
- const obj = this._test('normalize', form, function (value, state, options) {
- if (options.convert ||
- value === value.normalize(form)) {
- return value;
- }
- return this.createError('string.normalize', { value, form }, state, options);
- });
- obj._flags.normalize = form;
- return obj;
- }
- lowercase() {
- const obj = this._test('lowercase', undefined, function (value, state, options) {
- if (options.convert ||
- value === value.toLocaleLowerCase()) {
- return value;
- }
- return this.createError('string.lowercase', { value }, state, options);
- });
- obj._flags.case = 'lower';
- return obj;
- }
- uppercase() {
- const obj = this._test('uppercase', undefined, function (value, state, options) {
- if (options.convert ||
- value === value.toLocaleUpperCase()) {
- return value;
- }
- return this.createError('string.uppercase', { value }, state, options);
- });
- obj._flags.case = 'upper';
- return obj;
- }
- trim(enabled = true) {
- Hoek.assert(typeof enabled === 'boolean', 'option must be a boolean');
- if ((this._flags.trim && enabled) || (!this._flags.trim && !enabled)) {
- return this;
- }
- let obj;
- if (enabled) {
- obj = this._test('trim', undefined, function (value, state, options) {
- if (options.convert ||
- value === value.trim()) {
- return value;
- }
- return this.createError('string.trim', { value }, state, options);
- });
- }
- else {
- obj = this.clone();
- obj._tests = obj._tests.filter((test) => test.name !== 'trim');
- }
- obj._flags.trim = enabled;
- return obj;
- }
- replace(pattern, replacement) {
- if (typeof pattern === 'string') {
- pattern = new RegExp(Hoek.escapeRegex(pattern), 'g');
- }
- Hoek.assert(pattern instanceof RegExp, 'pattern must be a RegExp');
- Hoek.assert(typeof replacement === 'string', 'replacement must be a String');
- // This can not be considere a test like trim, we can't "reject"
- // anything from this rule, so just clone the current object
- const obj = this.clone();
- if (!obj._inner.replacements) {
- obj._inner.replacements = [];
- }
- obj._inner.replacements.push({
- pattern,
- replacement
- });
- return obj;
- }
- truncate(enabled) {
- const value = enabled === undefined ? true : !!enabled;
- if (this._flags.truncate === value) {
- return this;
- }
- const obj = this.clone();
- obj._flags.truncate = value;
- return obj;
- }
- };
- internals.compare = function (type, compare) {
- return function (limit, encoding) {
- const isRef = Ref.isRef(limit);
- Hoek.assert((Number.isSafeInteger(limit) && limit >= 0) || isRef, 'limit must be a positive integer or reference');
- Hoek.assert(!encoding || Buffer.isEncoding(encoding), 'Invalid encoding:', encoding);
- return this._test(type, limit, function (value, state, options) {
- let compareTo;
- if (isRef) {
- compareTo = limit(state.reference || state.parent, options);
- if (!Number.isSafeInteger(compareTo)) {
- return this.createError('string.ref', { ref: limit, value: compareTo }, state, options);
- }
- }
- else {
- compareTo = limit;
- }
- if (compare(value, compareTo, encoding)) {
- return value;
- }
- return this.createError('string.' + type, { limit: compareTo, value, encoding }, state, options);
- });
- };
- };
- internals.String.prototype.min = internals.compare('min', (value, limit, encoding) => {
- const length = encoding ? Buffer.byteLength(value, encoding) : value.length;
- return length >= limit;
- });
- internals.String.prototype.max = internals.compare('max', (value, limit, encoding) => {
- const length = encoding ? Buffer.byteLength(value, encoding) : value.length;
- return length <= limit;
- });
- internals.String.prototype.length = internals.compare('length', (value, limit, encoding) => {
- const length = encoding ? Buffer.byteLength(value, encoding) : value.length;
- return length === limit;
- });
- // Aliases
- internals.String.prototype.uuid = internals.String.prototype.guid;
- module.exports = new internals.String();
|