property will be respected!
- *
- * @param fileName
- * @return folder name where \ / | : ? * " < > 'control chars' replaced by '_'
- */
- public static String sanitizeFileName(final String fileName) {
- if (fileName == null)
- return null;
- if (fileName.equals(""))
- return "";
-
- String name = (PropertiesLoader.isForceSingleExtension()) ? UtilsFile
- .forceSingleExtension(fileName) : fileName;
-
- // Remove \ / | : ? * " < > 'Control Chars' with _
- return name.replaceAll("\\\\|/|\\||:|\\?|\\*|\"|<|>|\\p{Cntrl}", "_");
- }
/**
- * Do a cleanup of the folder name to avoid possible problems.
+ * Sanitizes a filename from certain chars.
+ *
+ * This method enforces the forceSingleExtension property and
+ * then replaces all occurrences of \, /, |, :, ?, *, ", <, >,
+ * control chars by _ (underscore).
+ *
+ * @param filename
+ * a potentially 'malicious' filename
+ * @return sanitized filename
+ */
+ public static String sanitizeFileName(final String filename) {
+
+ if (Utils.isEmpty(filename))
+ return filename;
+
+ String name = (PropertiesLoader.isForceSingleExtension()) ? UtilsFile
+ .forceSingleExtension(filename) : filename;
+
+ // Remove \ / | : ? * " < > 'Control Chars' with _
+ return name.replaceAll("\\\\|/|\\||:|\\?|\\*|\"|<|>|\\p{Cntrl}", "_");
+ }
+
+ /**
+ * Sanitizes a folder name from certain chars.
+ *
+ * This method replaces all occurrences of \, /, |, :, ?, *, ", <,
+ * >, control chars by _ (underscore).
*
* @param folderName
- * @return folder name where . \ / | : ? * " < > 'control chars'
- * replaced by '_'
+ * a potentially 'malicious' folder name
+ * @return sanitized folder name
*/
- public static String sanitizeFolderName(final String folderName) {
- if (folderName == null)
- return null;
- if (folderName.equals(""))
- return "";
-
- // Remove . \ / | : ? * " < > 'Control Chars' with _
- return folderName.replaceAll("\\.|\\\\|/|\\||:|\\?|\\*|\"|<|>|\\p{Cntrl}", "_");
- }
+ public static String sanitizeFolderName(final String folderName) {
+
+ if (Utils.isEmpty(folderName))
+ return folderName;
+
+ // Remove . \ / | : ? * " < > 'Control Chars' with _
+ return folderName.replaceAll(
+ "\\.|\\\\|/|\\||:|\\?|\\*|\"|<|>|\\p{Cntrl}", "_");
+ }
/**
- * Checks if the underlying file of the InputStream is an image.
+ * Checks if the underlying input stream contains an image.
*
- * @param in An input stream
- * @return true if the underlying file is an image else
+ * @param in
+ * input stream of an image
+ * @return true if the underlying input stream contains an
+ * image else false.
+ */
+ public static boolean isImage(final InputStream in) {
+ ImageInfo ii = new ImageInfo();
+ ii.setInput(in);
+ return ii.check();
+ }
+
+ /**
+ * Checks whether a path complied the FCKeditor File Browser rules.
+ * In particular a path has to comply with these rules.
+ *
+ * @param path
+ * a potentially 'malicious' path
+ * @return true if path complies to the rules else
* false.
*/
- public static boolean isImage(final InputStream in) {
- ImageInfo ii = new ImageInfo();
- ii.setInput(in);
- return ii.check();
- }
+ public static boolean isValidPath(final String path) {
+ if (Utils.isEmpty(path))
+ return false;
+ if (!path.startsWith("/"))
+ return false;
+ if (!path.endsWith("/"))
+ return false;
- /**
- * Checks if a path corresponds to the rules defined here.
- *
- * @param path
- * @return true if path corresponds to rules or
- * false.
- */
- public static boolean isValidPath(final String path) {
- if (Utils.isEmpty(path))
- return false;
- if (!path.startsWith("/"))
- return false;
- if (!path.endsWith("/"))
- return false;
-
- if (!path.equals(FilenameUtils.separatorsToUnix(FilenameUtils
- .normalize(path))))
- return false;
-
- return true;
- }
+ if (!path.equals(FilenameUtils.separatorsToUnix(FilenameUtils
+ .normalize(path))))
+ return false;
+
+ return true;
+ }
/**
@@ -113,25 +122,27 @@
*
* @param filename
+ * filename to sanitize
* @return string with a single dot only
*/
- public static String forceSingleExtension(final String filename) {
- return filename.replaceAll("\\.(?![^.]+$)", "_");
- }
+ public static String forceSingleExtension(final String filename) {
+ return filename.replaceAll("\\.(?![^.]+$)", "_");
+ }
/**
- * Checks if a filename contains more than one dot.
- *
- * @param filename
- * @return true if filename contains severals dots else
- * false
- */
- public static boolean isSingleExtension(final String filename) {
- return filename.matches("[^\\.]+\\.[^\\.]+");
- }
-
- /**
- * Checks for a dir and creates it if it does not exist.
+ * Checks if a filename contains more than one dot.
*
- * @param dir Directory to check/create.
+ * @param filename
+ * @return true if filename contains severals dots else
+ * false
+ */
+ public static boolean isSingleExtension(final String filename) {
+ return filename.matches("[^\\.]+\\.[^\\.]+");
+ }
+
+ /**
+ * Checks a directory for existence and creates it if non-existent.
+ *
+ * @param dir
+ * Directory to check/create.
*/
public static void checkDirAndCreate(File dir) {
@@ -141,17 +152,17 @@
/**
- * Ensures 'file' is a unique one.
- * If 'file' already exists, it will be renamed by using the following
- * pattern: basename(count).ext. For example, if the 'file' is
- * named "Test.doc", the names to be used, in order, are: "Test(1).doc",
- * "Test(2).doc", Test(3).doc"... and so on.
+ * Iterates over a base name and returns the first non-existent file.
+ * This method extracts a file's base name, iterates over it until the first
+ * non-existent appearance with basename(n).ext. Where n is a
+ * positive integer starting from one.
*
* @param file
- * @return Unique file.
+ * base file
+ * @return first non-existent file
*/
public static File getUniqueFile(final File file) {
if (!file.exists())
return file;
-
+
File tmpFile = new File(file.getAbsolutePath());
File parentDir = tmpFile.getParentFile();
@@ -160,5 +171,6 @@
String baseName = FilenameUtils.getBaseName(tmpFile.getName());
do {
- tmpFile = new File(parentDir, baseName + "(" + count++ + ")." + extension);
+ tmpFile = new File(parentDir, baseName + "(" + count++ + ")."
+ + extension);
} while (tmpFile.exists());
return tmpFile;
Index: /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/tool/UtilsResponse.java
===================================================================
--- /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/tool/UtilsResponse.java (revision 3357)
+++ /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/tool/UtilsResponse.java (revision 3358)
@@ -30,4 +30,10 @@
public class UtilsResponse {
+ /**
+ * Assembles a URL with omitted filename.
+ *
+ * @see #fileUrl(String, ResourceType, String, String)
+ *
+ */
public static String getUrl(String userFilesPath, ResourceType type,
String currentFolder) {
@@ -35,9 +41,24 @@
}
+ /**
+ *
+ * Assembles a file URL for the File Browser. Simply appends parameters to a
+ * string buffer with reasonable parameter checking.
+ *
+ * @param userFilesPath
+ * current userfiles path (may be null)
+ * @param type
+ * current resource type
+ * @param currentFolder
+ * selected current folder
+ * @param filename
+ * current chosen file (may be null)
+ * @return
+ */
public static String fileUrl(String userFilesPath, ResourceType type,
String currentFolder, String filename) {
-
+
StringBuffer sb = new StringBuffer();
- if(Utils.isNotEmpty(userFilesPath))
+ if (Utils.isNotEmpty(userFilesPath))
sb.append(userFilesPath);
sb.append(type.getPath());
@@ -45,5 +66,5 @@
if (Utils.isNotEmpty(filename))
sb.append(filename);
-
+
return sb.toString();
}
Index: /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/tool/XHtmlTagTool.java
===================================================================
--- /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/tool/XHtmlTagTool.java (revision 3357)
+++ /FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/tool/XHtmlTagTool.java (revision 3358)
@@ -25,7 +25,8 @@
/**
- * Tool to construct a XHTML tag.
+ * Java representation of an XHTML tag.
*
* Usage:
+ *
*
* XHtmlTagTool tag = XHtmlTagTool("a", "link");
@@ -34,9 +35,9 @@
*
*
- * Hint:
+ * Note:
*
* - Attributes are not ordered.
- * - If your tag shouldn't have a value but the tag has to close with '</[tagname]>', set
- * the value to {@link XHtmlTagTool#SPACE}.
+ * - If you want to avoid self-closing tags without supplying a value, set
+ * {@link #SPACE} as the tag's value.
*
*
@@ -52,24 +53,44 @@
/** Value of the tag. */
- private String value = null;
-
+ private String value;
+
/** Indicator to uses non self-closing tag. */
public static final String SPACE = " ";
+ /**
+ * Class constructor with tag name.
+ *
+ * @param name
+ * tag name
+ * @throws IllegalArgumentException
+ * if name is empty
+ */
+ public XHtmlTagTool(final String name) {
+ if (Utils.isEmpty(name))
+ throw new IllegalArgumentException(
+ "Parameter 'name' shouldn't be empty!");
+ this.name = name;
+ }
+
+ /**
+ * Class constructor with name and value.
+ *
+ * @param name
+ * tag name
+ * @param value
+ * tag value which is the tag body
+ * @throws IllegalArgumentException
+ * if name is empty
+ */
public XHtmlTagTool(final String name, final String value) {
- if (Utils.isEmpty(name))
- throw new IllegalArgumentException("Parameter 'name' shouldn't be empty!");
- this.name = name;
+ this(name);
this.value = value;
}
- public XHtmlTagTool(final String name) {
- this(name, null);
- }
-
/**
- * Setter for the value of the tag.
+ * Sets the tag value.
*
* @param value
+ * tag value which is the tag body
*/
public void setValue(final String value) {
@@ -81,15 +102,19 @@
*
* @param name
+ * attribute name
* @param value
- * @throws IllegalArgumentException if 'key' is empty.
+ * attribute value
+ * @throws IllegalArgumentException
+ * if 'name' is empty.
*/
public void addAttribute(final String name, final String value) {
if (Utils.isEmpty(name))
- throw new IllegalArgumentException("Parameter 'name' shouldn't be empty!");
+ throw new IllegalArgumentException(
+ "Parameter 'name' shouldn't be empty!");
attributes.put(name, value);
}
/**
- * Constructs the tag.
+ * Converts the tag to HTML.
*/
@Override
@@ -103,5 +128,6 @@
for (String key : attributes.keySet()) {
String val = attributes.get(key);
- tag.append(' ').append(key).append('=').append('\"').append(val).append('\"');
+ tag.append(' ').append(key).append('=').append('\"').append(val)
+ .append('\"');
}
@@ -121,4 +147,5 @@
try {
XHtmlTagTool tag = (XHtmlTagTool) obj;
+ // FIXME potential NPE on value
return value.equals(tag.value) && name.equals(tag.name)
&& attributes.equals(tag.attributes);
@@ -127,8 +154,13 @@
}
}
-
+
+ /**
+ * The hash code is merely a sum of name's, value's, and attributes' hash
+ * code.
+ */
@Override
public int hashCode() {
-
+
+ // FIXME potential NPE on value
return name.hashCode() + value.hashCode() + attributes.hashCode();
}