Skip to content

Validator: Fix name regexp #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 2, 2020
Merged

Validator: Fix name regexp #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c599bc
Change regexp to match the XML spec, supporting Unicode
orgads Nov 7, 2019
c995e2e
Merge branch 'master' into name-regexp
amitguptagwl Jan 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions spec/validator_utf8_with_BOM_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@
const validator = require("../src/validator");

describe("XMLParser", function() {

it("should validate xml string with cyrillic characters", function() {
const BOM = "\ufeff";
const options = {localeRange: "a-zA-Zа-яёА-ЯЁ"}
let xmlData = BOM + "<?xml version=\"1.0\" encoding=\"utf-8\" ?><КорневаяЗапись><Тэг>ЗначениеValue53456</Тэг></КорневаяЗапись>";
let result = validator.validate(xmlData, options);
let result = validator.validate(xmlData);
expect(result).toBe(true);

});
Expand Down
20 changes: 1 addition & 19 deletions spec/x_cyrillic_2j_str_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
"use strict";

const parser = require("../src/parser");
const validator = require("../src/validator");

describe("XMLParser", function() {

Expand All @@ -13,29 +12,12 @@ describe("XMLParser", function() {
}
};
const options = {
localeRange: "а-яёА-ЯЁa-zA-Z",
attributeNamePrefix : "@_"
}

const result = parser.parse(xmlData, options, { localeRange: "а-яёА-ЯЁa-zA-Z" });
const result = parser.parse(xmlData, options);
expect(result).toEqual(expected);
// console.log({ expected})
// console.log({ result })
});

it("should invalid XML with invalid localRange", function() {
const xmlData = `<КорневаяЗапись><Тэг>ЗначениеValue53456</Тэг></КорневаяЗапись>`;

const expected = {
"code": "InvalidOptions",
"msg": "Invalid localeRange",
"line": 1
};

const result = validator.validate(xmlData , { localeRange: "а-яёА-ЯЁa-zA-Z<" }).err
expect(result).toEqual(expected);
// console.log({ expected})
// console.log({ result })
});

});
2 changes: 0 additions & 2 deletions src/parser.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ type X2jOptions = {
trimValues: boolean;
cdataTagName: false | string;
cdataPositionChar: string;
localeRange: string;
parseTrueNumberOnly: boolean;
tagValueProcessor: (tagValue: string, tagName: string) => string;
attrValueProcessor: (attrValue: string, attrName: string) => string;
Expand All @@ -20,7 +19,6 @@ type X2jOptions = {
type X2jOptionsOptional = Partial<X2jOptions>;
type validationOptions = {
allowBooleanAttributes: boolean;
localeRange: string;
};
type validationOptionsOptional = Partial<validationOptions>;
type J2xOptions = {
Expand Down
17 changes: 9 additions & 8 deletions src/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
'use strict';

const nameStartChar = ':A-Za-z_\\u00C0-\\u00D6\\u00D8-\\u00F6\\u00F8-\\u02FF\\u0370-\\u037D\\u037F-\\u1FFF\\u200C-\\u200D\\u2070-\\u218F\\u2C00-\\u2FEF\\u3001-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFFD';
const nameChar = nameStartChar + '\\-.\\d\\u00B7\\u0300-\\u036F\\u203F-\\u2040';
const nameRegexp = '[' + nameStartChar + '][' + nameChar + ']*'
const regexName = new RegExp('^' + nameRegexp + '$');

const getAllMatches = function(string, regex) {
const matches = [];
let match = regex.exec(string);
Expand All @@ -15,15 +20,11 @@ const getAllMatches = function(string, regex) {
return matches;
};

const doesMatch = function(string, regex) {
const match = regex.exec(string);
const isName = function(string) {
const match = regexName.exec(string);
return !(match === null || typeof match === 'undefined');
};

const doesNotMatch = function(string, regex) {
return !doesMatch(string, regex);
};

exports.isExist = function(v) {
return typeof v !== 'undefined';
};
Expand Down Expand Up @@ -81,6 +82,6 @@ exports.buildOptions = function(options, defaultOptions, props) {
return newOptions;
};

exports.doesMatch = doesMatch;
exports.doesNotMatch = doesNotMatch;
exports.isName = isName;
exports.getAllMatches = getAllMatches;
exports.nameRegexp = nameRegexp;
31 changes: 11 additions & 20 deletions src/validator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ const util = require('./util');

const defaultOptions = {
allowBooleanAttributes: false, //A tag can have attributes without any value
localeRange: 'a-zA-Z',
};

const props = ['allowBooleanAttributes', 'localeRange'];
const props = ['allowBooleanAttributes'];

//const tagsPattern = new RegExp("<\\/?([\\w:\\-_\.]+)\\s*\/?>","g");
exports.validate = function (xmlData, options) {
Expand All @@ -16,12 +15,6 @@ exports.validate = function (xmlData, options) {
//xmlData = xmlData.replace(/(\r\n|\n|\r)/gm,"");//make it single line
//xmlData = xmlData.replace(/(^\s*<\?xml.*?\?>)/g,"");//Remove XML starting tag
//xmlData = xmlData.replace(/(<!DOCTYPE[\s\w\"\.\/\-\:]+(\[.*\])*\s*>)/g,"");//Remove DOCTYPE
const localRangeRegex = new RegExp(`[${options.localeRange}]`);

if (localRangeRegex.test("<#$'\"\\\/:0")) {
return getErrorObject('InvalidOptions', 'Invalid localeRange', 1);
}

const tags = [];
let tagFound = false;

Expand All @@ -32,8 +25,7 @@ exports.validate = function (xmlData, options) {
// check for byte order mark (BOM)
xmlData = xmlData.substr(1);
}
const regxAttrName = new RegExp(`^[${options.localeRange}_][${options.localeRange}0-9_\\-\\.:]*$`);
const regxTagName = new RegExp(`^([${options.localeRange}_])[${options.localeRange}0-9\\.\\-_:]*$`);

for (let i = 0; i < xmlData.length; i++) {
if (xmlData[i] === '<') {
//starting of tag
Expand Down Expand Up @@ -78,7 +70,7 @@ exports.validate = function (xmlData, options) {
//continue;
i--;
}
if (!validateTagName(tagName, regxTagName)) {
if (!validateTagName(tagName)) {
let msg;
if(tagName.trim().length === 0) {
msg = "There is an unnecessary space between tag name and backward slash '</ ..'.";
Expand All @@ -98,7 +90,7 @@ exports.validate = function (xmlData, options) {
if (attrStr[attrStr.length - 1] === '/') {
//self closing tag
attrStr = attrStr.substring(0, attrStr.length - 1);
const isValid = validateAttributeString(attrStr, options, regxAttrName);
const isValid = validateAttributeString(attrStr, options);
if (isValid === true) {
tagFound = true;
//continue; //text may presents after self closing tag
Expand Down Expand Up @@ -126,7 +118,7 @@ exports.validate = function (xmlData, options) {
}
}
} else {
const isValid = validateAttributeString(attrStr, options, regxAttrName);
const isValid = validateAttributeString(attrStr, options);
if (isValid !== true) {
//the result from the nested function returns the position of the error within the attribute
//in order to get the 'true' error line, we need to calculate the position where the attribute begins (i - attrStr.length) and then add the position within the attribute
Expand Down Expand Up @@ -303,7 +295,7 @@ const validAttrStrRegxp = new RegExp('(\\s*)([^\\s=]+)(\\s*=)?(\\s*([\'"])(([\\s

//attr, ="sd", a="amit's", a="sd"b="saf", ab cd=""

function validateAttributeString(attrStr, options, regxAttrName) {
function validateAttributeString(attrStr, options) {
//console.log("start:"+attrStr+":end");

//if(attrStr.trim().length === 0) return true; //empty string
Expand All @@ -323,7 +315,7 @@ function validateAttributeString(attrStr, options, regxAttrName) {
return { err: { code:"InvalidAttr",msg:"attribute " + matches[i][2] + " has no value assigned."}};
} */
const attrName = matches[i][2];
if (!validateAttrName(attrName, regxAttrName)) {
if (!validateAttrName(attrName)) {
return getErrorObject('InvalidAttr', `Attribute '${attrName}' is an invalid name.`, getPositionFromMatch(attrStr, matches[i][0]));
}
if (!attrNames.hasOwnProperty(attrName)) {
Expand Down Expand Up @@ -382,19 +374,18 @@ function getErrorObject(code, message, lineNumber) {
};
}

function validateAttrName(attrName, regxAttrName) {
// const validAttrRegxp = new RegExp(regxAttrName);
return util.doesMatch(attrName, regxAttrName);
function validateAttrName(attrName) {
return util.isName(attrName);
}

//const startsWithXML = new RegExp("^[Xx][Mm][Ll]");
// startsWith = /^([a-zA-Z]|_)[\w.\-_:]*/;

function validateTagName(tagname, regxTagName) {
function validateTagName(tagname) {
/*if(util.doesMatch(tagname,startsWithXML)) return false;
else*/
//return !tagname.toLowerCase().startsWith("xml") || !util.doesNotMatch(tagname, regxTagName);
return !util.doesNotMatch(tagname, regxTagName);
return util.isName(tagname);
}

//this function returns the line number for the character at the given index
Expand Down
16 changes: 7 additions & 9 deletions src/xmlstr2xmlnode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ const util = require('./util');
const buildOptions = require('./util').buildOptions;
const xmlNode = require('./xmlNode');
const TagType = {OPENING: 1, CLOSING: 2, SELF: 3, CDATA: 4};
let regx =
'<((!\\[CDATA\\[([\\s\\S]*?)(]]>))|(([\\w:\\-._]*:)?([\\w:\\-._]+))([^>]*)>|((\\/)(([\\w:\\-._]*:)?([\\w:\\-._]+))\\s*>))([^<]*)';
const regx =
'<((!\\[CDATA\\[([\\s\\S]*?)(]]>))|((NAME:)?(NAME))([^>]*)>|((\\/)(NAME)\\s*>))([^<]*)'
.replace(/NAME/g, util.nameRegexp);

//const tagsRegx = new RegExp("<(\\/?[\\w:\\-\._]+)([^>]*)>(\\s*"+cdataRegx+")*([^<]+)?","g");
//const tagsRegx = new RegExp("<(\\/?)((\\w*:)?([\\w:\\-\._]+))([^>]*)>([^<]*)("+cdataRegx+"([^<]*))*([^<]+)?","g");
Expand All @@ -32,7 +33,6 @@ const defaultOptions = {
trimValues: true, //Trim string values of tag and attributes
cdataTagName: false,
cdataPositionChar: '\\c',
localeRange: '',
tagValueProcessor: function(a, tagName) {
return a;
},
Expand All @@ -58,7 +58,6 @@ const props = [
'trimValues',
'cdataTagName',
'cdataPositionChar',
'localeRange',
'tagValueProcessor',
'attrValueProcessor',
'parseTrueNumberOnly',
Expand All @@ -74,7 +73,6 @@ const getTraversalObj = function(xmlData, options) {
const xmlObj = new xmlNode('!xml');
let currentNode = xmlObj;

regx = regx.replace(/\[\\w/g, '[' + options.localeRange + '\\w');
const tagsRegx = new RegExp(regx, 'g');
let tag = tagsRegx.exec(xmlData);
let nextTag = tagsRegx.exec(xmlData);
Expand All @@ -83,7 +81,7 @@ const getTraversalObj = function(xmlData, options) {

if (tagType === TagType.CLOSING) {
//add parsed data to parent node
if (currentNode.parent && tag[14]) {
if (currentNode.parent && tag[12]) {
currentNode.parent.val = util.getValue(currentNode.parent.val) + '' + processTagValue(tag, options, currentNode.parent.tagname);
}
if (options.stopNodes.length && options.stopNodes.includes(currentNode.tagname)) {
Expand All @@ -101,14 +99,14 @@ const getTraversalObj = function(xmlData, options) {
//for backtracking
currentNode.val = util.getValue(currentNode.val) + options.cdataPositionChar;
//add rest value to parent node
if (tag[14]) {
if (tag[12]) {
currentNode.val += processTagValue(tag, options);
}
} else {
currentNode.val = (currentNode.val || '') + (tag[3] || '') + processTagValue(tag, options);
}
} else if (tagType === TagType.SELF) {
if (currentNode && tag[14]) {
if (currentNode && tag[12]) {
currentNode.val = util.getValue(currentNode.val) + '' + processTagValue(tag, options);
}

Expand Down Expand Up @@ -142,7 +140,7 @@ const getTraversalObj = function(xmlData, options) {

function processTagValue(parsedTags, options, parentTagName) {
const tagName = parsedTags[7] || parentTagName;
let val = parsedTags[14];
let val = parsedTags[12];
if (val) {
if (options.trimValues) {
val = val.trim();
Expand Down