KTS-2742

"Create/identify a function to test for acceptable characters that should be supported in file names and folder names." Fixed. Committed By: Conrad Vermeulen Reviewed By: Megan Watson git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@8084 c91229c3-7414-0410-bfa2-8a42b809f60b

KTS-2742
"Create/identify a function to test for acceptable characters that should be supported in file names and folder names." Fixed. Committed By: Conrad Vermeulen Reviewed By: Megan Watson git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@8084 c91229c3-7414-0410-bfa2-8a42b809f60b
conradverm
1 parent f47d81b4
Showing 5 changed files with 61 additions and 7 deletions
ktapi/KTAPIDocument.inc.php
ktapi/KTAPIFolder.inc.php
ktwebservice/nunit/document_rename.cs
ktwebservice/nunit/folder.cs
lib/util/ktutil.inc
@@ -159,6 +159,8 @@ class KTAPI_Document extends KTAPI_FolderItem
 			return new PEAR_Error(KTAPI_ERROR_DOCUMENT_NOT_CHECKED_OUT);
 		}
+		$filename = KTUtil::replaceInvalidCharacters($filename);
+
 		$options = array('major_update'=>$major_update);
 		$currentfilename = $this->document->getFileName();
@@ -664,6 +666,7 @@ class KTAPI_Document extends KTAPI_FolderItem
 		{
 			return $user;
 		}
+		$newname = KTUtil::replaceInvalidCharacters($newname);
 		DBUtil::startTransaction();
 		$res = KTDocumentUtil::rename($this->document, $newname, $user);
@@ -743,6 +746,7 @@ class KTAPI_Document extends KTAPI_FolderItem
 		{
 			return $user;
 		}
+		$newname = KTUtil::replaceInvalidCharacters($newname);
 		if ($this->document->getName() != $newname)
 		{
@@ -1164,6 +1168,7 @@ class KTAPI_Document extends KTAPI_FolderItem
 					$documents['immutable'] = in_array(strtolower($value), array('1','true','on','yes'))?'1':'0';
 					break;
 				case 'filename':
+					$value = KTUtil::replaceInvalidCharacters($value);
 					$document_content['filename'] = $value;
 					break;
 				case 'major_version':
@@ -180,6 +180,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 			{
 				continue;
 			}
+			$foldername = KTUtil::replaceInvalidCharacters($foldername);
 			$foldername = sanitizeForSQL($foldername);
 			$sql = "SELECT id FROM folders WHERE
 					(name='$foldername' and parent_id=$folderid) OR
@@ -234,6 +235,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 		$foldername = dirname($documentname);
 		$documentname = basename($documentname);
+		$documentname = KTUtil::replaceInvalidCharacters($documentname);
 		$ktapi_folder = $this;
@@ -592,7 +594,9 @@ class KTAPI_Folder extends KTAPI_FolderItem
 			return $user;
 		}
+		$title = KTUtil::replaceInvalidCharacters($title);
 		$filename = basename($filename);
+		$filename = KTUtil::replaceInvalidCharacters($filename);
 		$documenttypeid = KTAPI::get_documenttypeid($documenttype);
 		if (PEAR::isError($documenttypeid))
 		{
@@ -649,6 +653,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 		{
 			return $user;
 		}
+		$foldername = KTUtil::replaceInvalidCharacters($foldername);
 		DBUtil::startTransaction();
 		$result = KTFolderUtil::add($this->folder, $foldername, $user);
@@ -705,6 +710,7 @@ class KTAPI_Folder extends KTAPI_FolderItem
 		{
 			return $user;
 		}
+		$newname = KTUtil::replaceInvalidCharacters($newname);
 		DBUtil::startTransaction();
 		$result = KTFolderUtil::rename($this->folder, $newname, $user);
@@ -35,6 +35,14 @@ namespace MonoTests.KnowledgeTree
 			response = this._kt.rename_document_title(this._session, this._doc1.docId, "test title");
 			Assert.AreEqual(0, response.status_code);
 			Assert.AreEqual("test title", response.title);
-	    	}
+	    }
+
+	    [Test]
+		public void RenameWithInvalidCharactersTest()
+		{
+			kt_document_detail response = this._kt.rename_document_filename(this._session, this._doc1.docId, "te<s'`me");
+			Assert.AreEqual(0, response.status_code);
+			Assert.AreEqual("te-s--me", response.filename);
+	    }
 	}
 }
@@ -99,9 +99,9 @@ namespace MonoTests.KnowledgeTree
 			kt_folder_detail response2 = this._kt.get_folder_detail(this._session, this._subfolder_id);
 			Assert.AreEqual(0, response2.status_code);
 			Assert.AreEqual(this._subfolder_id, response2.id);
-			Assert.AreEqual("subfolde'r2", response2.folder_name);
+			Assert.AreEqual("subfolde-r2", response2.folder_name);
 			Assert.AreEqual(this._folder_id, response2.parent_id);
-			Assert.AreEqual("kt_unit_test/subfolde'r2", response2.full_path);
+			Assert.AreEqual("kt_unit_test/subfolde-r2", response2.full_path);
 	    }
 		[Test]
@@ -120,15 +120,16 @@ namespace MonoTests.KnowledgeTree
 	    		response = this._kt.create_folder(this._session, 1, "kt ' unit \" test");
 		       	Assert.AreEqual(0,response.status_code);
-		       	Assert.AreEqual("kt ' unit \" test",response.folder_name);
+		       	Assert.AreEqual("kt - unit - test",response.folder_name);
+		       	// this fails because the previous folder makes a folder with the same name because of invalid character substitution
 	    		response = this._kt.create_folder(this._session, 1, "kt - unit - test");
-		       	Assert.AreEqual(0,response.status_code);
-		       	Assert.AreEqual("kt - unit - test",response.folder_name);
+		       	Assert.AreEqual(22,response.status_code);
+//		       	Assert.AreEqual("kt - unit - test",response.folder_name);
 		       	response = this._kt.get_folder_detail_by_name(this._session, "/kt ' unit \" test");
 		       	Assert.AreEqual(0,response.status_code);
-		       	Assert.AreEqual("kt ' unit \" test",response.folder_name);
+		       	Assert.AreEqual("kt - unit - test",response.folder_name);
 		}
 		[Test]
@@ -117,6 +117,40 @@ class KTUtil {
 		}
 	}
+
+
+	static $invalidFilenameCharacters = array('\\','/',':','*','?','"','<','>','|','%','+','\'','`');
+
+	/**
+	 * Checks if a filename is valid
+	 *
+	 * @param string $filename
+	 * @return boolean
+	 */
+	static function isValidFilename($filename)
+	{
+		foreach(KTUtil::$invalidFilenameCharacters as $char)
+		{
+			if (strpos($filename, $char) !== false)
+			{
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	static function replaceInvalidCharacters($filename)
+	{
+		foreach(KTUtil::$invalidFilenameCharacters as $char)
+		{
+			$filename = str_replace($char, '-', $filename);
+		}
+
+		return $filename;
+	}
+
+
     function extractGPC () {
         foreach (func_get_args() as $var) {
             if (array_key_exists($var, $_REQUEST)) {