names.js

/*
Script page: https://wiki.openstreetmap.org/wiki/User:SafwatHalaby/scripts/nameCopy
Last update: 12 June 2018
major version: 5
Typical node fetching query (Overpass API):

[out:xml][timeout:200][bbox:29.4013195,33.8818359,33.4131022,36.0791016];
(area(3601473946); area(3603791785);)->.a;
(
	node["name"](if:
		t["name"] != t["name:ar"] &&
		t["name"] != t["name:he"] &&
		t["name"] != t["name:en"] &&
		t["name"] != t["name:ru"]
	)(area.a);

	way["name"](if:
		t["name"] != t["name:ar"] &&
		t["name"] != t["name:he"] &&
		t["name"] != t["name:en"] &&
		t["name"] != t["name:ru"]
	)(area.a);

	rel["name"](if:
		t["name"] != t["name:ar"] &&
		t["name"] != t["name:he"] &&
		t["name"] != t["name:en"] &&
		t["name"] != t["name:ru"]
	)(area.a);
);
out meta;
*/

var Api = require("josm/api").Api;
var print = require("josm/util").println;
var ERR_DEBUG = false;

// custom Remove to fix the bug https://forum.openstreetmap.org/viewtopic.php?id=58375
var remove;
(function()
{
	var removeFunction;
	var builder= require("josm/builder");
	var nb = builder.NodeBuilder;
	var tempNode = nb.withPosition(10,10).create();
	removeFunction = tempNode.remove;
	remove = function remove(p, tag)
	{
		removeFunction.call(p, tag);
	}
})();

// 00A0 is non breaking space
// 2013 is an EN-DASH
function heEnOnly(str)
{
	return ((str.search(/[^\u00A0\u0020-\u007E\u0590-\u05FF\u2013]/) === -1)  // only common symbols and letters
	&& (str.search(/[\u0590-\u05FF]/) !== -1)); // at least 1 he letter
}
function arEnOnly(str)
{
	return ((str.search(/[^\u00A0\u0020-\u007E\u0600-\u06FF\u2013]/) === -1)  // only common symbols and ar letters
	&& (str.search(/[\u0600-\u06FF]/) !== -1)); // at least 1 ar letter
}

function enOnly(str)
{
	return (str.search(/[^\u00A0\u0020-\u007E\u2013]/) === -1) && // Only common symbols and en letters
	(str.search(/[a-zA-Z]/) !== -1); // at least 1 en letter
}

function numbersOnly(str)
{
	return (str.search(/[^0-9\\\/\-\_\;\(\)\{\}\.\s]/) === -1);
}

function hasInvalidChars(str)
{
	return (str.search(/[\u0000-\u001F\u007F]/) !== -1);
}

gErrCnt = 0;
function printErr(p, str)
{
	gErrCnt++;
	var preStr;
	if (p.isWay) preStr = "https://www.openstreetmap.org/way/" + p.id;
	else if (p.isNode) preStr = "https://www.openstreetmap.org/node/" + p.id;
	else if (p.isRelation) preStr = "https://www.openstreetmap.org/relation/" + p.id;
	else preStr = p.id;
	print(preStr + ": " + str);
	if (ERR_DEBUG) p.tags["DBG_NAME"] = "HAS_ERROR";
}

function sameValue(str1, str2)
{
	// treat nbsp and sp as the same in comparisons
	return (str1.replace(/\u00A0/, ' ') == str2.replace(/\u00A0/, ' '));
}

var gWhiteSpaceFixes = 0;
function fixWhiteSpace(p)
{
	for (key in p.tags)
	{
		str = p.tags[key];
		newStr = str.trim().replace(/\s{2,}/, ' ');
		if (newStr != str)
		{
			p.tags[key] = newStr;
			++gWhiteSpaceFixes;
		}
	}
}


var languages = [
{name: "English", tag: "name:en", check: enOnly, copyCnt: 0},
{name: "Hebrew", tag: "name:he", check: heEnOnly, copyCnt: 0},
{name: "Arabic", tag: "name:ar", check: arEnOnly, copyCnt: 0}
];

function addFixme(p, str)
{
	str += " Flagged by SafwatHalaby_bot-nameCopy";
	if ((p.tags.fixme === undefined) || (p.tags.fixme === ""))
	{
		p.tags.fixme = str;
		return true;
	}
	else if (p.tags.fixme.indexOf("SafwatHalaby") == -1)
	{
		p.tags.fixme = "; " + str;
		return true;
	}
	return false;
}

function main()
{
	var modifiedCnt = 0;
	var totalCnt = 0;
	var engFixCnt = 0;
	var mismatchCnt = 0;
	var fixmeCnt = 0;
	
	print("");
	print("### Running script");
	print("The following errors need human attention:");
	var layer = josm.layers.get(0);
	var ds = layer.data;
	ds.each(function(p) // for each element
	{
		totalCnt++;
		var name = p.tags["name"];

		// Basic whitespace fixes for all keys and not just name keys
		fixWhiteSpace(p);

		// Basic integrity checks for all tags except name, name:ar,name:en,name:he
		for (key in p.tags)
		{
			if ((key == "name") || (key == "name:he") || (key == "name:en") || (key == "name:ar")) continue;
			if(hasInvalidChars(p.tags[key]))
			{
				printErr(p, key + ' has invalid characters.');
			}
		}

		if ((p.tags["name:en"] !== undefined) && (name === p.tags["name:en"]) && (!enOnly(p.tags["name:en"])))
		{
			// remove bug in previous version, where ascii sentences with no letters at all were copied to name:en
			p.removeTag("name:en");
			engFixCnt++;
		}
		
		// check ar,he,en integrity
		for (var i = 0; i < languages.length; ++i)
		{
			var lang = languages[i];
			var nameLang = p.tags[lang.tag];
			if (nameLang !== undefined)
			{
				if(hasInvalidChars(nameLang))
				{
					printErr(p, lang.tag + ' has invalid characters.');
				}
				else if (!lang.check(nameLang))
				{
					printErr(p, lang.tag + ' is not ' + lang.name + '.');
				}	
			}
		}
		
		if (name !== undefined) // name exists
		{
			if (p.tags["noname"] !== undefined) remove(p, "noname");
			
			// check name integrity
			if (hasInvalidChars(name))
			{
				printErr(p, 'name has non printable characters.');
				return;
			}
			
			// detect "name" tag's language and consider copying it to name:lang
			for (var i = 0; i < languages.length; ++i)
			{
				var lang = languages[i];
				var nameLang = p.tags[lang.tag];
				if (lang.check(name))
				{
					// detection succeeded for this language
					if (nameLang === undefined)
					{
						//name:lang does not exist. Copy name to name:lang.
						p.tags[lang.tag] = name;
						modifiedCnt++;
						lang.copyCnt++;
					}
					else if (!sameValue(nameLang, name)) // normalized string comparison, ignoring spaces etc
					{
						// name:lang already exists but it does not match name.
						var str = "name, " + lang.tag + " mismatch.";
						mismatchCnt++;
						if (addFixme(p, str)) // add only if a fixme isn't already present
						{
							fixmeCnt++;
							str += " Fixme added.";
						}
						else
						{
							str += " Already has a fixme.";
						}
						printErr(p, str);
					}
					return;
				}
			}
			
			// If we're here language detection didn't work for any of he, ar, en
			if (!numbersOnly(name))
				printErr(p, "name is not ar,he,en");
		}
	});
	print("");
	print("Total names copies: " + modifiedCnt);
	print("Total mismatches: " + mismatchCnt);
	print("Total fixmes added: " + fixmeCnt);
	print("Eng bugfixes: " + engFixCnt);
	var checksum = 0;
	for (var i = 0; i < languages.length; ++i)
	{
		var lang = languages[i];
		print("Total name to " + lang.tag + ": " + lang.copyCnt);
		checksum += lang.copyCnt;
	}
	print("Whitespace fixes: " + gWhiteSpaceFixes);
	print("Total scanned: " + totalCnt);
	print("Total unhandled errors: " + gErrCnt);
	if (checksum != modifiedCnt)
		print("SERIOUS ERROR: THIS SHOULD NEVER HAPPEN.");
	print("");
	print("### Script finished");
}
main();