[erdiag.git] / parser.js

// ER diagram description parser
class ErDiags
{
	constructor(description)
	{
		this.entities = {};
		this.inheritances = [];
		this.associations = [];
		this.txt2json(description);
		this.tables = [];
		// Cache SVG graphs returned by server (in addition to server cache = good perfs)
		this.mcdGraph = "";
		this.mldGraph = "";
		this.sqlText = "";
	}

	static get TYPES()
	{
		// SQLite storage classes without null
		return ["integer","real","text","blob"];
	}

	static get CARDINAL()
	{
		return {
			"*": "0,n",
			"+": "1,n",
			"?": "0,1",
			"1": "1,1"
		};
	}

	//////////////////
	// PARSING STAGE 1
	//////////////////

	// Parse a textual description into a json object
	txt2json(text)
	{
		let lines = text.split("\n");
		lines.push(""); //easier parsing: always empty line at the end
		let start = -1;
		for (let i=0; i < lines.length; i++)
		{
			lines[i] = lines[i].trim();
			// Empty line ?
			if (lines[i].length == 0)
			{
				if (start >= 0) //there is some group of lines to parse
				{
					this.parseThing(lines, start, i);
					start = -1;
				}
			}
			else //not empty line: just register starting point
			{
				if (start < 0)
					start = i;
			}
		}
	}

	// Parse a group of lines into entity, association, ...
	parseThing(lines, start, end) //start included, end excluded
	{
		switch (lines[start].charAt(0))
		{
			case '[':
				// Entity = { name: { attributes, [weak] } }
				let name = lines[start].match(/[^\[\]\s]+/)[0];
				let entity = { attributes: this.parseAttributes(lines, start+1, end) };
				if (lines[start].charAt(1) == '[')
					entity.weak = true;
				this.entities[name] = entity;
				break;
			case 'i': //inheritance (arrows)
				this.inheritances = this.inheritances.concat(this.parseInheritance(lines, start+1, end));
				break;
			case '{': //association
				// Association = { [name], [attributes], [weak], entities: ArrayOf entity indices }
				let relationship = { };
				let nameRes = lines[start].match(/[^{}\s]+/);
				if (nameRes !== null)
					relationship.name = nameRes[0];
				if (lines[start].charAt(1) == '{')
					relationship.weak = true;
				this.associations.push(Object.assign({}, relationship, this.parseAssociation(lines, start+1, end)));
				break;
		}
	}

	// attributes: ArrayOf {name, [isKey], [type], [qualifiers]}
	parseAttributes(lines, start, end)
	{
		let attributes = [];
		for (let i=start; i<end; i++)
		{
			let field = { };
			let line = lines[i];
			if (line.charAt(0) == '#')
			{
				field.isKey = true;
				line = line.slice(1);
			}
			field.name = line.match(/[^()\s]+/)[0];
			let parenthesis = line.match(/\((.+)\)/);
			if (parenthesis !== null)
			{
				let sqlClues = parenthesis[1];
				let qualifiers = sqlClues;
				let firstWord = sqlClues.match(/[^\s]+/)[0];
				if (ErDiags.TYPES.includes(firstWord))
				{
					field.type = firstWord;
					qualifiers = sqlClues.substring(firstWord.length).trim();
				}
				field.qualifiers = qualifiers;
			}
			attributes.push(field);
		}
		return attributes;
	}

	// GroupOf Inheritance: { parent, children: ArrayOf entity indices }
	parseInheritance(lines, start, end)
	{
		let inheritance = [];
		for (let i=start; i<end; i++)
		{
			let lineParts = lines[i].split(" ");
			let children = [];
			for (let j=1; j<lineParts.length; j++)
				children.push(lineParts[j]);
			inheritance.push({ parent:lineParts[0], children: children });
		}
		return inheritance;
	}

	// Association (parsed here): { entities: ArrayOf entity names + cardinality, [attributes: ArrayOf {name, [isKey], [type], [qualifiers]}] }
	parseAssociation(lines, start, end)
	{
		let assoce = { };
		let entities = [];
		let i = start;
		while (i < end)
		{
			if (lines[i].charAt(0) == '-')
			{
				assoce.attributes = this.parseAttributes(lines, i+1, end);
				break;
			}
			else
			{
				// Read entity name + cardinality
				let lineParts = lines[i].split(" ");
				entities.push({ name:lineParts[0], card:lineParts[1] });
			}
			i++;
		}
		assoce.entities = entities;
		return assoce;
	}

	//////////////////
	// PARSING STAGE 2
	//////////////////

	static AjaxGet(dotInput, callback)
	{
		let xhr = new XMLHttpRequest();
		xhr.onreadystatechange = function() {
			if (this.readyState == 4 && this.status == 200)
				callback(this.responseText);
		};
		xhr.open("GET", "scripts/getGraphSvg.php?dot=" + encodeURIComponent(dotInput), true);
		xhr.send();
	}

	// "Modèle conceptuel des données". TODO: option for graph size
	// NOTE: randomizing helps to obtain better graphs (sometimes)
	drawMcd(id, mcdStyle) //mcdStyle: bubble, or compact
	{
		let element = document.getElementById(id);
		mcdStyle = mcdStyle || "compact";
		if (this.mcdGraph.length > 0)
		{
			element.innerHTML = this.mcdGraph;
			return;
		}
		// Build dot graph input
		let mcdDot = 'graph {\n';
		mcdDot += 'rankdir="LR";\n';
		// Nodes:
		if (mcdStyle == "compact")
			mcdDot += "node [shape=plaintext];\n";
		_.shuffle(Object.keys(this.entities)).forEach( name => {
			if (mcdStyle == "bubble")
			{
				mcdDot += name + '[shape=rectangle, label="' + name + '"';
				if (this.entities[name].weak)
					mcdDot += ', peripheries=2';
				mcdDot += '];\n';
				if (!!this.entities[name].attributes)
				{
					_.shuffle(this.entities[name].attributes).forEach( a => {
						let label = (a.isKey ? '#' : '') + a.name;
						let attrName = name + '_' + a.name;
						mcdDot += attrName + '[shape=ellipse, label="' + label + '"];\n';
						if (Math.random() < 0.5)
							mcdDot += attrName + ' -- ' + name + ';\n';
						else
							mcdDot += name + ' -- ' + attrName + ';\n';
					});
				}
			}
			else
			{
				mcdDot += name + '[label=<';
				if (this.entities[name].weak)
				{
					mcdDot += '<table port="name" BORDER="1" ALIGN="LEFT" CELLPADDING="0" CELLSPACING="3" CELLBORDER="0">' +
						'<tr><td><table BORDER="1" ALIGN="LEFT" CELLPADDING="5" CELLSPACING="0">\n';
				}
				else
					mcdDot += '<table port="name" BORDER="1" ALIGN="LEFT" CELLPADDING="5" CELLSPACING="0">\n';
				mcdDot += '<tr><td BGCOLOR="#ae7d4e" BORDER="0"><font COLOR="#FFFFFF">' + name + '</font></td></tr>\n';
				if (!!this.entities[name].attributes)
				{
					this.entities[name].attributes.forEach( a => {
						let label = (a.isKey ? '<u>' : '') + a.name + (a.isKey ? '</u>' : '');
						mcdDot += '<tr><td BGCOLOR="#FFFFFF" BORDER="0" ALIGN="LEFT"><font COLOR="#000000" >' + label + '</font></td></tr>\n';
					});
				}
				mcdDot += '</table>';
				if (this.entities[name].weak)
					mcdDot += '</td></tr></table>';
				mcdDot += '>];\n';
			}
		});
		// Inheritances:
		this.inheritances.forEach( i => {
			_.shuffle(i.children).forEach( c => {
				if (Math.random() < 0.5)
					mcdDot += c + ':name -- ' + i.parent;
				else
					mcdDot += i.parent + ':name -- ' + c;
				mcdDot += ':name [dir="forward", arrowhead="vee", style="dashed"];\n';
			});
		});
		// Relationships:
		let assoceCounter = 0;
		_.shuffle(this.associations).forEach( a => {
			let name = !!a.name && a.name.length > 0
				? a.name
				: '_assoce' + assoceCounter++;
			mcdDot += name + '[shape="diamond", style="filled", color="lightgrey", label="' + (!!a.name ? a.name : '') + '"';
			if (a.weak)
				mcdDot += ', peripheries=2';
			mcdDot += '];\n';
			_.shuffle(a.entities).forEach( e => {
				if (Math.random() < 0.5)
					mcdDot += e.name + ':name -- ' + name;
				else
					mcdDot += name + ' -- ' + e.name + ':name';
				mcdDot += '[label="' + ErDiags.CARDINAL[e.card] + '"];\n';
			});
			if (!!a.attributes)
			{
				_.shuffle(a.attributes).forEach( attr => {
					let label = (attr.isKey ? '#' : '') + attr.name;
					mcdDot += name + '_' + attr.name + '[shape=ellipse, label="' + label + '"];\n';
					let attrName = name + '_' + attr.name;
					if (Math.random() < 0.5)
						mcdDot += attrName + ' -- ' + name + ';\n';
					else
						mcdDot += name + ' -- ' + attrName + ';\n';
				});
			}
		});
		mcdDot += '}';
		console.log(mcdDot);
		ErDiags.AjaxGet(mcdDot, graphSvg => {
			this.mcdGraph = graphSvg;
			element.innerHTML = graphSvg;
		});
	}

	// "Modèle logique des données"
	// TODO: this one should draw links from foreign keys to keys (port=... in <TD>)
	drawMld(id)
	{
		let element = document.getElementById(id);
		if (this.mldGraph.length > 0)
		{
			element.innerHTML = this.mcdGraph;
			return;
		}
		// Build dot graph input
		let mldDot = 'graph {\n';
		// Nodes:
		Object.keys(this.entities).forEach( name => {
			//mld. ... --> devient table
			// mldDot = ...
		});
		// Relationships:
		this.associations.forEach( a => {
			a.entities.forEach( e => { // e.card e.name ...
				// Pass 1 : entites deviennent tables
				// Pass 2 : sur les assoces
				// multi-arite : sub-loop si 0,1 ou 1,1 : aspiré comme attribut de l'association (phase 1)
				// ensuite, que du 0,n ou 1,n : si == 1, OK une table
				// si 2 ou + : n tables + 1 pour l'assoce, avec attrs clés étrangères
				// clé étrangère NOT NULL si 1,1
			});
		});
		// this.graphMld = ...
		//console.log(mldDot);
		ErDiags.AjaxGet(mldDot, graphSvg => {
			this.mldGraph = graphSvg;
			element.innerHTML = graphSvg;
		});
	}

	fillSql(id)
	{
		let element = document.getElementById(id);
		if (this.sqlText.length > 0)
		{
			element.innerHTML = this.sqlText;
			return;
		}
		//UNIMPLEMENTED (should be straightforward from MLD)
	}
}
Commit	Line	Data
525c4d2a BA	1	// ER diagram description parser
	2	class ErDiags
	3	{
	4	constructor(description)
	5	{
	6	this.entities = {};
	7	this.inheritances = [];
	8	this.associations = [];
	9	this.txt2json(description);
e2610c05	10	this.tables = [];
525c4d2a BA	11	// Cache SVG graphs returned by server (in addition to server cache = good perfs)
	12	this.mcdGraph = "";
	13	this.mldGraph = "";
	14	this.sqlText = "";
	15	}
	16
	17	static get TYPES()
	18	{
d6c9499e	19	// SQLite storage classes without null
525c4d2a BA	20	return ["integer","real","text","blob"];
	21	}
	22
	23	static get CARDINAL()
	24	{
	25	return {
	26	"*": "0,n",
	27	"+": "1,n",
	28	"?": "0,1",
	29	"1": "1,1"
	30	};
	31	}
	32
	33	//////////////////
	34	// PARSING STAGE 1
	35	//////////////////
	36
	37	// Parse a textual description into a json object
	38	txt2json(text)
	39	{
	40	let lines = text.split("\n");
	41	lines.push(""); //easier parsing: always empty line at the end
	42	let start = -1;
	43	for (let i=0; i < lines.length; i++)
	44	{
	45	lines[i] = lines[i].trim();
	46	// Empty line ?
	47	if (lines[i].length == 0)
	48	{
	49	if (start >= 0) //there is some group of lines to parse
	50	{
	51	this.parseThing(lines, start, i);
	52	start = -1;
	53	}
	54	}
	55	else //not empty line: just register starting point
	56	{
	57	if (start < 0)
	58	start = i;
	59	}
	60	}
	61	}
	62
	63	// Parse a group of lines into entity, association, ...
	64	parseThing(lines, start, end) //start included, end excluded
	65	{
	66	switch (lines[start].charAt(0))
	67	{
	68	case '[':
	69	// Entity = { name: { attributes, [weak] } }
d6c9499e	70	let name = lines[start].match(/[^\[\]\s]+/)[0];
525c4d2a BA	71	let entity = { attributes: this.parseAttributes(lines, start+1, end) };
	72	if (lines[start].charAt(1) == '[')
	73	entity.weak = true;
	74	this.entities[name] = entity;
	75	break;
	76	case 'i': //inheritance (arrows)
	77	this.inheritances = this.inheritances.concat(this.parseInheritance(lines, start+1, end));
	78	break;
	79	case '{': //association
	80	// Association = { [name], [attributes], [weak], entities: ArrayOf entity indices }
	81	let relationship = { };
d6c9499e	82	let nameRes = lines[start].match(/[^{}\s]+/);
525c4d2a BA	83	if (nameRes !== null)
	84	relationship.name = nameRes[0];
	85	if (lines[start].charAt(1) == '{')
	86	relationship.weak = true;
	87	this.associations.push(Object.assign({}, relationship, this.parseAssociation(lines, start+1, end)));
	88	break;
	89	}
	90	}
	91
	92	// attributes: ArrayOf {name, [isKey], [type], [qualifiers]}
	93	parseAttributes(lines, start, end)
	94	{
	95	let attributes = [];
	96	for (let i=start; i<end; i++)
	97	{
d6c9499e BA	98	let field = { };
	99	let line = lines[i];
	100	if (line.charAt(0) == '#')
	101	{
525c4d2a	102	field.isKey = true;
d6c9499e BA	103	line = line.slice(1);
	104	}
	105	field.name = line.match(/[^()\s]+/)[0];
	106	let parenthesis = line.match(/\((.+)\)/);
525c4d2a BA	107	if (parenthesis !== null)
	108	{
	109	let sqlClues = parenthesis[1];
	110	let qualifiers = sqlClues;
d6c9499e	111	let firstWord = sqlClues.match(/[^\s]+/)[0];
525c4d2a BA	112	if (ErDiags.TYPES.includes(firstWord))
	113	{
	114	field.type = firstWord;
	115	qualifiers = sqlClues.substring(firstWord.length).trim();
	116	}
	117	field.qualifiers = qualifiers;
	118	}
	119	attributes.push(field);
	120	}
	121	return attributes;
	122	}
	123
	124	// GroupOf Inheritance: { parent, children: ArrayOf entity indices }
	125	parseInheritance(lines, start, end)
	126	{
	127	let inheritance = [];
	128	for (let i=start; i<end; i++)
	129	{
	130	let lineParts = lines[i].split(" ");
	131	let children = [];
	132	for (let j=1; j<lineParts.length; j++)
	133	children.push(lineParts[j]);
	134	inheritance.push({ parent:lineParts[0], children: children });
	135	}
	136	return inheritance;
	137	}
	138
	139	// Association (parsed here): { entities: ArrayOf entity names + cardinality, [attributes: ArrayOf {name, [isKey], [type], [qualifiers]}] }
	140	parseAssociation(lines, start, end)
	141	{
	142	let assoce = { };
	143	let entities = [];
	144	let i = start;
	145	while (i < end)
	146	{
	147	if (lines[i].charAt(0) == '-')
	148	{
	149	assoce.attributes = this.parseAttributes(lines, i+1, end);
	150	break;
	151	}
	152	else
	153	{
	154	// Read entity name + cardinality
	155	let lineParts = lines[i].split(" ");
	156	entities.push({ name:lineParts[0], card:lineParts[1] });
	157	}
	158	i++;
	159	}
	160	assoce.entities = entities;
	161	return assoce;
	162	}
	163
	164	//////////////////
	165	// PARSING STAGE 2
	166	//////////////////
	167
	168	static AjaxGet(dotInput, callback)
	169	{
	170	let xhr = new XMLHttpRequest();
	171	xhr.onreadystatechange = function() {
	172	if (this.readyState == 4 && this.status == 200)
	173	callback(this.responseText);
	174	};
	175	xhr.open("GET", "scripts/getGraphSvg.php?dot=" + encodeURIComponent(dotInput), true);
176	xhr.send();
177	}
178
179	// "Modèle conceptuel des données". TODO: option for graph size
48a55161	180	// NOTE: randomizing helps to obtain better graphs (sometimes)
525c4d2a BA	181	drawMcd(id, mcdStyle) //mcdStyle: bubble, or compact
	182	{
	183	let element = document.getElementById(id);
	184	mcdStyle = mcdStyle \|\| "compact";
	185	if (this.mcdGraph.length > 0)
	186	{
	187	element.innerHTML = this.mcdGraph;
	188	return;
	189	}
	190	// Build dot graph input
	191	let mcdDot = 'graph {\n';
48a55161	192	mcdDot += 'rankdir="LR";\n';
525c4d2a	193	// Nodes:
48a55161 BA	194	if (mcdStyle == "compact")
	195	mcdDot += "node [shape=plaintext];\n";
	196	_.shuffle(Object.keys(this.entities)).forEach( name => {
525c4d2a BA	197	if (mcdStyle == "bubble")
	198	{
	199	mcdDot += name + '[shape=rectangle, label="' + name + '"';
	200	if (this.entities[name].weak)
	201	mcdDot += ', peripheries=2';
	202	mcdDot += '];\n';
	203	if (!!this.entities[name].attributes)
	204	{
48a55161	205	_.shuffle(this.entities[name].attributes).forEach( a => {
525c4d2a	206	let label = (a.isKey ? '#' : '') + a.name;
48a55161 BA	207	let attrName = name + '_' + a.name;
	208	mcdDot += attrName + '[shape=ellipse, label="' + label + '"];\n';
	209	if (Math.random() < 0.5)
	210	mcdDot += attrName + ' -- ' + name + ';\n';
	211	else
	212	mcdDot += name + ' -- ' + attrName + ';\n';
525c4d2a BA	213	});
	214	}
	215	}
	216	else
	217	{
48a55161	218	mcdDot += name + '[label=<';
525c4d2a BA	219	if (this.entities[name].weak)
	220	{
	221	mcdDot += '<table port="name" BORDER="1" ALIGN="LEFT" CELLPADDING="0" CELLSPACING="3" CELLBORDER="0">' +
	222	'<tr><td><table BORDER="1" ALIGN="LEFT" CELLPADDING="5" CELLSPACING="0">\n';
	223	}
	224	else
	225	mcdDot += '<table port="name" BORDER="1" ALIGN="LEFT" CELLPADDING="5" CELLSPACING="0">\n';
	226	mcdDot += '<tr><td BGCOLOR="#ae7d4e" BORDER="0"><font COLOR="#FFFFFF">' + name + '</font></td></tr>\n';
	227	if (!!this.entities[name].attributes)
	228	{
	229	this.entities[name].attributes.forEach( a => {
	230	let label = (a.isKey ? '<u>' : '') + a.name + (a.isKey ? '</u>' : '');
	231	mcdDot += '<tr><td BGCOLOR="#FFFFFF" BORDER="0" ALIGN="LEFT"><font COLOR="#000000" >' + label + '</font></td></tr>\n';
	232	});
	233	}
	234	mcdDot += '</table>';
	235	if (this.entities[name].weak)
	236	mcdDot += '</td></tr></table>';
	237	mcdDot += '>];\n';
	238	}
	239	});
	240	// Inheritances:
	241	this.inheritances.forEach( i => {
48a55161 BA	242	_.shuffle(i.children).forEach( c => {
	243	if (Math.random() < 0.5)
	244	mcdDot += c + ':name -- ' + i.parent;
	245	else
	246	mcdDot += i.parent + ':name -- ' + c;
	247	mcdDot += ':name [dir="forward", arrowhead="vee", style="dashed"];\n';
525c4d2a BA	248	});
	249	});
	250	// Relationships:
	251	let assoceCounter = 0;
48a55161	252	_.shuffle(this.associations).forEach( a => {
525c4d2a BA	253	let name = !!a.name && a.name.length > 0
	254	? a.name
	255	: '_assoce' + assoceCounter++;
	256	mcdDot += name + '[shape="diamond", style="filled", color="lightgrey", label="' + (!!a.name ? a.name : '') + '"';
	257	if (a.weak)
	258	mcdDot += ', peripheries=2';
	259	mcdDot += '];\n';
48a55161 BA	260	_.shuffle(a.entities).forEach( e => {
	261	if (Math.random() < 0.5)
	262	mcdDot += e.name + ':name -- ' + name;
	263	else
eabe4071	264	mcdDot += name + ' -- ' + e.name + ':name';
48a55161	265	mcdDot += '[label="' + ErDiags.CARDINAL[e.card] + '"];\n';
525c4d2a BA	266	});
	267	if (!!a.attributes)
	268	{
48a55161	269	_.shuffle(a.attributes).forEach( attr => {
525c4d2a	270	let label = (attr.isKey ? '#' : '') + attr.name;
48a55161 BA	271	mcdDot += name + '_' + attr.name + '[shape=ellipse, label="' + label + '"];\n';
	272	let attrName = name + '_' + attr.name;
	273	if (Math.random() < 0.5)
	274	mcdDot += attrName + ' -- ' + name + ';\n';
	275	else
	276	mcdDot += name + ' -- ' + attrName + ';\n';
525c4d2a BA	277	});
	278	}
	279	});
	280	mcdDot += '}';
48a55161	281	console.log(mcdDot);
525c4d2a BA	282	ErDiags.AjaxGet(mcdDot, graphSvg => {
	283	this.mcdGraph = graphSvg;
	284	element.innerHTML = graphSvg;
d6c9499e	285	});
525c4d2a BA	286	}
	287
	288	// "Modèle logique des données"
48a55161	289	// TODO: this one should draw links from foreign keys to keys (port=... in <TD>)
525c4d2a BA	290	drawMld(id)
	291	{
	292	let element = document.getElementById(id);
	293	if (this.mldGraph.length > 0)
	294	{
	295	element.innerHTML = this.mcdGraph;
	296	return;
	297	}
e2610c05 BA	298	// Build dot graph input
	299	let mldDot = 'graph {\n';
	300	// Nodes:
	301	Object.keys(this.entities).forEach( name => {
	302	//mld. ... --> devient table
	303	// mldDot = ...
	304	});
	305	// Relationships:
	306	this.associations.forEach( a => {
	307	a.entities.forEach( e => { // e.card e.name ...
	308	// Pass 1 : entites deviennent tables
	309	// Pass 2 : sur les assoces
	310	// multi-arite : sub-loop si 0,1 ou 1,1 : aspiré comme attribut de l'association (phase 1)
	311	// ensuite, que du 0,n ou 1,n : si == 1, OK une table
	312	// si 2 ou + : n tables + 1 pour l'assoce, avec attrs clés étrangères
	313	// clé étrangère NOT NULL si 1,1
	314	});
	315	});
525c4d2a	316	// this.graphMld = ...
d6c9499e BA	317	//console.log(mldDot);
	318	ErDiags.AjaxGet(mldDot, graphSvg => {
	319	this.mldGraph = graphSvg;
	320	element.innerHTML = graphSvg;
	321	});
525c4d2a BA	322	}
	323
	324	fillSql(id)
	325	{
	326	let element = document.getElementById(id);
	327	if (this.sqlText.length > 0)
	328	{
	329	element.innerHTML = this.sqlText;
	330	return;
	331	}
	332	//UNIMPLEMENTED (should be straightforward from MLD)
	333	}
	334	}