From: Mathieu Baudier <mbaudier@argeo.org>
Date: Mon, 2 May 2011 14:39:00 +0000 (+0000)
Subject: Remove invalid characters from JCR names
X-Git-Tag: argeo-commons-2.1.30~1263
X-Git-Url: https://git.argeo.org/?a=commitdiff_plain;h=c67af45e20260984b7895cb9993be344d75b0d11;p=lgpl%2Fargeo-commons.git

Remove invalid characters from JCR names

git-svn-id: https://svn.argeo.org/commons/trunk@4490 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc
---

diff --git a/server/runtime/org.argeo.server.jcr/src/main/java/org/argeo/jcr/JcrUtils.java b/server/runtime/org.argeo.server.jcr/src/main/java/org/argeo/jcr/JcrUtils.java
index cf0d2d74a..853555d98 100644
--- a/server/runtime/org.argeo.server.jcr/src/main/java/org/argeo/jcr/JcrUtils.java
+++ b/server/runtime/org.argeo.server.jcr/src/main/java/org/argeo/jcr/JcrUtils.java
@@ -60,6 +60,17 @@ import org.argeo.ArgeoException;
 public class JcrUtils implements ArgeoJcrConstants {
 	private final static Log log = LogFactory.getLog(JcrUtils.class);
 
+	/**
+	 * Not complete yet. See
+	 * http://www.day.com/specs/jcr/2.0/3_Repository_Model.html#3.2.2%20Local
+	 * %20Names
+	 */
+	public final static char[] INVALID_NAME_CHARACTERS = { '/', ':', '[', ']',
+			'|', '*', /*
+					 * invalid XML chars :
+					 */
+			'<', '>', '&' };
+
 	/** Prevents instantiation */
 	private JcrUtils() {
 	}
@@ -90,13 +101,6 @@ public class JcrUtils implements ArgeoJcrConstants {
 		return node;
 	}
 
-	/** Removes forbidden characters from a path, replacing them with '_' */
-	public static String removeForbiddenCharacters(String str) {
-		return str.replace('[', '_').replace(']', '_').replace('/', '_')
-				.replace('*', '_');
-
-	}
-
 	/** Retrieves the parent path of the provided path */
 	public static String parentPath(String path) {
 		if (path.equals("/"))
@@ -589,13 +593,60 @@ public class JcrUtils implements ArgeoJcrConstants {
 	}
 
 	/**
-	 * Normalize a name so taht it can be stores in contexts not supporting
+	 * Normalizes a name so that it can be stored in contexts not supporting
 	 * names with ':' (typically databases). Replaces ':' by '_'.
 	 */
 	public static String normalize(String name) {
 		return name.replace(':', '_');
 	}
 
+	/**
+	 * Replaces characters which are invalid in a JCR name by '_'. Currently not
+	 * exhaustive.
+	 * 
+	 * @see JcrUtils#INVALID_NAME_CHARACTERS
+	 */
+	public static String replaceInvalidChars(String name) {
+		return replaceInvalidChars(name, '_');
+	}
+
+	/**
+	 * Replaces characters which are invalid in a JCR name. Currently not
+	 * exhaustive.
+	 * 
+	 * @see JcrUtils#INVALID_NAME_CHARACTERS
+	 */
+	public static String replaceInvalidChars(String name, char replacement) {
+		boolean modified = false;
+		char[] arr = name.toCharArray();
+		for (int i = 0; i < arr.length; i++) {
+			char c = arr[i];
+			invalid: for (char invalid : INVALID_NAME_CHARACTERS) {
+				if (c == invalid) {
+					arr[i] = replacement;
+					modified = true;
+					break invalid;
+				}
+			}
+		}
+		if (modified)
+			return new String(arr);
+		else
+			// do not create new object if unnecessary
+			return name;
+	}
+
+	/**
+	 * Removes forbidden characters from a path, replacing them with '_'
+	 * 
+	 * @deprecated use {@link #replaceInvalidChars(String)} instead
+	 */
+	public static String removeForbiddenCharacters(String str) {
+		return str.replace('[', '_').replace(']', '_').replace('/', '_')
+				.replace('*', '_');
+
+	}
+
 	/** Cleanly disposes a {@link Binary} even if it is null. */
 	public static void closeQuietly(Binary binary) {
 		if (binary == null)