COMMON: Remove various variants of the md5_file / md5_file_string funcs; turned the (disabled) MD5 test code into a working unit test

svn-id: r46108

7 files changed, 78 insertions, 162 deletions

diff --git a/common/md5.cpp b/common/md5.cpp
index a1b60816c6..df544ca0f0 100644
--- a/common/md5.cpp
+++ b/common/md5.cpp
@@ -31,20 +31,19 @@
 #include "common/file.h"
 #include "common/fs.h"
 #include "common/md5.h"
-#include "common/util.h"
 #include "common/endian.h"
 
 namespace Common {
 
-typedef struct {
+struct md5_context {
 	uint32 total[2];
 	uint32 state[4];
 	uint8 buffer[64];
-} md5_context;
+};
 
-void md5_starts(md5_context *ctx);
-void md5_update(md5_context *ctx, const uint8 *input, uint32 length);
-void md5_finish(md5_context *ctx, uint8 digest[16]);
+static void md5_starts(md5_context *ctx);
+static void md5_update(md5_context *ctx, const uint8 *input, uint32 length);
+static void md5_finish(md5_context *ctx, uint8 digest[16]);
 
 
 #define GET_UINT32(n, b, i)	(n) = READ_LE_UINT32(b + i)
@@ -246,41 +245,6 @@ void md5_finish(md5_context *ctx, uint8 digest[16]) {
 	PUT_UINT32(ctx->state[3], digest, 12);
 }
 
-bool md5_file(const FSNode &file, uint8 digest[16], uint32 length) {
-	if (!file.exists()) {
-		warning("md5_file: using an inexistent FSNode");
-		return false;
-	} else if (!file.isReadable()) {
-		warning("md5_file: using an unreadable FSNode");
-		return false;
-	} else if (file.isDirectory()) {
-		warning("md5_file: using a directory FSNode");
-		return false;
-	}
-
-	ReadStream *stream = file.createReadStream();
-	if (!stream) {
-		warning("md5_file: failed to open '%s'", file.getPath().c_str());
-		return false;
-	}
-
-	bool result =  md5_file(*stream, digest, length);
-	delete stream;
-	return result;
-}
-
-bool md5_file(const char *name, uint8 digest[16], uint32 length) {
-	File f;
-
-	f.open(name);
-	if (!f.isOpen()) {
-		warning("md5_file couldn't open '%s'", name);
-		return false;
-	}
-
-	return md5_file(f, digest, length);
-}
-
 
 bool md5_file(ReadStream &stream, uint8 digest[16], uint32 length) {
 
@@ -316,30 +280,6 @@ bool md5_file(ReadStream &stream, uint8 digest[16], uint32 length) {
 	return true;
 }
 
-bool md5_file_string(const FSNode &file, char *md5str, uint32 length) {
-	uint8 digest[16];
-	if (!md5_file(file, digest, length))
-		return false;
-
-	for (int i = 0; i < 16; i++) {
-		snprintf(md5str + i*2, 3, "%02x", (int)digest[i]);
-	}
-
-	return true;
-}
-
-bool md5_file_string(const char *name, char *md5str, uint32 length) {
-	uint8 digest[16];
-	if (!md5_file(name, digest, length))
-		return false;
-
-	for (int i = 0; i < 16; i++) {
-		snprintf(md5str + i*2, 3, "%02x", (int)digest[i]);
-	}
-
-	return true;
-}
-
 bool md5_file_string(ReadStream &stream, char *md5str, uint32 length) {
 	uint8 digest[16];
 	if (!md5_file(stream, digest, length))
@@ -353,78 +293,3 @@ bool md5_file_string(ReadStream &stream, char *md5str, uint32 length) {
 }
 
 } // End of namespace Common
-
-#ifdef TEST
-
-#include <stdlib.h>
-#include <stdio.h>
-
-/*
- * those are the standard RFC 1321 test vectors
- */
-
-static const char *msg[] = {
-	"",
-	"a",
-	"abc",
-	"message digest",
-	"abcdefghijklmnopqrstuvwxyz",
-	"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789",
-	"12345678901234567890123456789012345678901234567890123456789012" \
-		"345678901234567890"
-};
-
-static const char *val[] = {
-	"d41d8cd98f00b204e9800998ecf8427e",
-	"0cc175b9c0f1b6a831c399e269772661",
-	"900150983cd24fb0d6963f7d28e17f72",
-	"f96b697d7cb7938d525a2f31aaf161d0",
-	"c3fcd3d76192e4007dfb496cca67e13b",
-	"d174ab98d277d9f5a5611c2c9f419d9f",
-	"57edf4a22be3c955ac49da2e2107b67a"
-};
-
-int main(int argc, char *argv[]) {
-	int i, j;
-	char output[33];
-	md5_context ctx;
-	unsigned char md5sum[16];
-
-	if (argc < 2) {
-		printf("\n MD5 Validation Tests:\n\n");
-
-		for (i = 0; i < 7; i++) {
-			printf(" Test %d ", i + 1);
-
-			md5_starts(&ctx);
-			md5_update(&ctx, (const uint8 *)msg[i], strlen(msg[i]));
-			md5_finish(&ctx, md5sum);
-
-			for (j = 0; j < 16; j++) {
-				sprintf(output + j * 2, "%02x", md5sum[j]);
-			}
-
-			if (memcmp(output, val[i], 32)) {
-				printf("failed!\n");
-				return 1;
-			}
-
-			printf("passed.\n");
-		}
-
-		printf("\n");
-	} else {
-		for (i = 1; i < argc; i++) {
-			md5_file(argv[i], md5sum);
-			for (j = 0; j < 16; j++) {
-				printf("%02x", md5sum[j]);
-			}
-
-			printf("  %s\n", argv[i]);
-		}
-	}
-
-	return 0;
-}
-
-#endif
diff --git a/common/md5.h b/common/md5.h
index ffed7d7524..1fb937ae9b 100644
--- a/common/md5.h
+++ b/common/md5.h
@@ -29,22 +29,16 @@
 
 namespace Common {
 
-class FSNode;
 class ReadStream;
 
-bool md5_file(const char *name, uint8 digest[16], uint32 length = 0);
-bool md5_file(const FSNode &file, uint8 digest[16], uint32 length = 0);
 bool md5_file(ReadStream &stream, uint8 digest[16], uint32 length = 0);
 
-// The following two methods work similar to the above two, but
-// instead of computing the binary MD5 digest, they produce
+// The following method work similar to the above one, but
+// instead of computing the binary MD5 digest, it produces
 // a human readable lowercase hexstring representing the digest.
 // The md5str parameter must point to a buffer of 32+1 chars.
-bool md5_file_string(const char *name, char *md5str, uint32 length = 0);
-bool md5_file_string(const FSNode &file, char *md5str, uint32 length = 0);
 bool md5_file_string(ReadStream &stream, char *md5str, uint32 length = 0);
 
-
 } // End of namespace Common
 
 #endif
diff --git a/engines/advancedDetector.cpp b/engines/advancedDetector.cpp
index 7d86f3ef32..1c60ea949d 100644
--- a/engines/advancedDetector.cpp
+++ b/engines/advancedDetector.cpp
@@ -370,16 +370,18 @@ static ADGameDescList detectGame(const Common::FSList &fslist, const ADParams &p
 				debug(3, "+ %s", fname.c_str());
 
 				SizeMD5 tmp;
-				if (!md5_file_string(allFiles[fname], tmp.md5, params.md5Bytes))
-					tmp.md5[0] = 0;
-
-				debug(3, "> '%s': '%s'", fname.c_str(), tmp.md5);
-
 				Common::File testFile;
-				if (testFile.open(allFiles[fname]))
+
+				if (testFile.open(allFiles[fname])) {
 					tmp.size = (int32)testFile.size();
-				else
+					if (!md5_file_string(testFile, tmp.md5, params.md5Bytes))
+						tmp.md5[0] = 0;
+				} else {
 					tmp.size = -1;
+					tmp.md5[0] = 0;
+				}
+
+				debug(3, "> '%s': '%s'", fname.c_str(), tmp.md5);
 
 				filesSizeMD5[fname] = tmp;
 			}
diff --git a/engines/scumm/detection.cpp b/engines/scumm/detection.cpp
index 4d984caa6d..c23d8a5529 100644
--- a/engines/scumm/detection.cpp
+++ b/engines/scumm/detection.cpp
@@ -378,7 +378,8 @@ static void detectGames(const Common::FSList &fslist, Common::List<DetectorResul
 		//
 		DetectorDesc &d = fileMD5Map[file];
 		if (d.md5.empty()) {
-			if (Common::md5_file_string(d.node, md5str, kMD5FileSizeLimit)) {
+			Common::File tmp;
+			if (tmp.open(d.node) && Common::md5_file_string(tmp, md5str, kMD5FileSizeLimit)) {
 
 				d.md5 = md5str;
 				d.md5Entry = findInMD5Table(md5str);
diff --git a/engines/scumm/file_nes.cpp b/engines/scumm/file_nes.cpp
index e2604039a4..27840b6865 100644
--- a/engines/scumm/file_nes.cpp
+++ b/engines/scumm/file_nes.cpp
@@ -1371,7 +1371,9 @@ bool ScummNESFile::open(const Common::String &filename) {
 
 	if (_ROMset == kROMsetNum) {
 		char md5str[32+1];
-		if (Common::md5_file_string(filename.c_str(), md5str)) {
+		File f;
+		f.open(filename);
+		if (f.isOpen() && Common::md5_file_string(f, md5str)) {
 
 			if (!strcmp(md5str, "3905799e081b80a61d4460b7b733c206")) {
 				_ROMset = kROMsetUSA;
diff --git a/engines/tinsel/detection.cpp b/engines/tinsel/detection.cpp
index 038c0c9625..e4ee52247e 100644
--- a/engines/tinsel/detection.cpp
+++ b/engines/tinsel/detection.cpp
@@ -740,14 +740,16 @@ const ADGameDescription *TinselMetaEngine::fallbackDetect(const Common::FSList &
 			Common::String fname(tempFilename);
 			if (allFiles.contains(fname) && !filesSizeMD5.contains(fname)) {
 				SizeMD5 tmp;
-				if (!md5_file_string(allFiles[fname], tmp.md5, detectionParams.md5Bytes))
-					tmp.md5[0] = 0;
-
 				Common::File testFile;
-				if (testFile.open(allFiles[fname]))
+
+				if (testFile.open(allFiles[fname])) {
 					tmp.size = (int32)testFile.size();
-				else
+					if (!md5_file_string(testFile, tmp.md5, detectionParams.md5Bytes))
+						tmp.md5[0] = 0;
+				} else {
 					tmp.size = -1;
+					tmp.md5[0] = 0;
+				}
 
 				filesSizeMD5[fname] = tmp;
 			}
diff --git a/test/common/md5.h b/test/common/md5.h
new file mode 100644
index 0000000000..c59b6dc853
--- /dev/null
+++ b/test/common/md5.h
@@ -0,0 +1,50 @@
+#include <cxxtest/TestSuite.h>
+
+#include "common/md5.h"
+#include "common/stream.h"
+
+/*
+ * those are the standard RFC 1321 test vectors
+ */
+static const char *md5_test_string[] = {
+	"",
+	"a",
+	"abc",
+	"message digest",
+	"abcdefghijklmnopqrstuvwxyz",
+	"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789",
+	"12345678901234567890123456789012345678901234567890123456789012" \
+		"345678901234567890"
+};
+
+static const char *md5_test_digest[] = {
+	"d41d8cd98f00b204e9800998ecf8427e",
+	"0cc175b9c0f1b6a831c399e269772661",
+	"900150983cd24fb0d6963f7d28e17f72",
+	"f96b697d7cb7938d525a2f31aaf161d0",
+	"c3fcd3d76192e4007dfb496cca67e13b",
+	"d174ab98d277d9f5a5611c2c9f419d9f",
+	"57edf4a22be3c955ac49da2e2107b67a"
+};
+
+class MD5TestSuite : public CxxTest::TestSuite {
+	public:
+	void test_md5_file() {
+		int i, j;
+		char output[33];
+		unsigned char md5sum[16];
+
+		for (i = 0; i < 7; i++) {
+			Common::MemoryReadStream stream((const byte *)md5_test_string[i], strlen(md5_test_string[i]));
+			Common::md5_file(stream, md5sum);
+
+			for (j = 0; j < 16; j++) {
+				sprintf(output + j * 2, "%02x", md5sum[j]);
+			}
+
+			Common::String tmp(output);
+			TS_ASSERT_EQUALS(tmp, md5_test_digest[i]);
+		}
+	}
+
+};