DownloadManager: rework hash comparison functions for useful errors.

Also lowercases hashes from Lua. The calculated digests are always
converted to lowercase strings.

Author: torque

threaded-libcurl/DownloadManager.cpp

@@ -89,26 +89,26 @@ int DownloadManager::busy( void ) {
 
 // These are kind of out of place but they are useful.
 
-int DownloadManager::checkFileSHA1( const std::string filename, const std::string expected ) {
+std::string DownloadManager::getFileSHA1( const std::string filename ) {
 	std::string buffer;
 	std::fstream inFile( filename, std::ios::in | std::ios::binary | std::ios::ate );
 	if (inFile.is_open( )) {
 		buffer.resize( inFile.tellg( ) );
 		inFile.seekg( 0, std::ios::beg );
 		inFile.read( &buffer[0], buffer.size( ) );
 		inFile.close( );
-		return checkStringSHA1( buffer, expected );
+		return getStringSHA1( buffer );
 	}
-	return -1;
+	return "";
 }
 
-int DownloadManager::checkStringSHA1( const std::string string, const std::string expected ) {
+std::string DownloadManager::getStringSHA1( const std::string string ) {
 	SHA1_CTX ctx;
 	uint8_t digest[SHA1_DIGEST_SIZE];
 	SHA1_Init( &ctx );
 	SHA1_Update( &ctx, reinterpret_cast<const uint8_t*>(string.c_str( )), string.size( ) );
 	SHA1_Final( &ctx, digest );
-	return sha1compare( digest, expected );
+	return digestToHex( digest );
 }
 
 /*

threaded-libcurl/DownloadManager.hpp

@@ -9,7 +9,7 @@ class DownloadManager {
 	unsigned int finishedCount = 0, addedCount = 0, failedCount = 0;
 
 	public:
-		const static unsigned int version = 0x000101;
+		const static unsigned int version = 0x000102;
 		DownloadManager( void );
 		~DownloadManager( void );
 		double getProgress( void );
@@ -20,6 +20,6 @@ class DownloadManager {
 		void terminate( void );
 		void clear( void );
 		int busy( void );
-		static int checkFileSHA1( std::string filename, std::string expected );
-		static int checkStringSHA1( std::string string, std::string expecteds );
+		static std::string getFileSHA1( std::string filename );
+		static std::string getStringSHA1( std::string string );
 };

threaded-libcurl/DownloadManager.moon

@@ -1,4 +1,4 @@
-[[   ---------- Usage ----------
+[[---------- Usage ----------
 
 1. Create a DownloadManager:
 
@@ -67,11 +67,11 @@ void Sleep(unsigned long);
 sleep = ffi.os == "Windows" and (( ms = 100 ) -> ffi.C.Sleep ms) or (( ms = 100 ) -> ffi.C.usleep ms*1000)
 
 class DownloadManager
-	@version = 0x000103
-	@version_string = "0.1.3"
+	@version = 0x000104
+	@version_string = "0.1.4"
 
 	DM = nil
-	DMVersion = 0x000101
+	DMVersion = 0x000102
 	pathExt = "/automation/include/#{@__name}/#{(ffi.os != 'Windows') and 'lib' or ''}#{@__name}.#{(OSX: 'dylib', Windows: 'dll')[ffi.os] or 'so'}"
 	defaultLibraryPaths = aegisub and {aegisub.decode_path("?user"..pathExt), aegisub.decode_path("?data"..pathExt)} or {@__name}
 	msgs = {
@@ -137,6 +137,10 @@ class DownloadManager
 				-- lfs.mkdir returns nil on success and error alike
 				return nil, err if err
 
+		-- make sure sha1 is lowercase for comparison.
+		if sha1
+			sha1 = sha1\lower!
+
 		DM.addDownload @manager, url, outfile, sha1
 		@downloadCount += 1
 		@downloads[@downloadCount] = id:@downloadCount, :url, :outfile, :sha1
@@ -182,17 +186,17 @@ class DownloadManager
 	-- just make them instance methods than trying to juggle the DM init.
 	-- Also make them fat arrow functions for calling consistency.
 	checkFileSHA1: ( filename, expected ) =>
-		switch DM.checkFileSHA1 filename, expected
-			when -1
-				return nil
-			when 0
-				return true
-			when 1
-				return false
+		result = DM.getFileSHA1 filename
+		if nil == result
+			return nil, "Could not open file #{filename}."
+		if result == expected\lower!
+			return true
+		else
+			return false, "Hash mismatch. Got #{result}, expected #{expected}."
 
 	checkStringSHA1: ( string, expected ) =>
-		switch DM.checkStringSHA1 filename, expected
-			when 0
-				return true
-			when 1
-				return false
+		result = DM.getStringSHA1 string
+		if result == expected\lower!
+			return true
+		else
+			return false, "Hash mismatch. Got #{result}, expected #{expected}."

threaded-libcurl/DownloadManagerC.cpp

@@ -40,12 +40,16 @@ extern "C" {
 		reinterpret_cast<DownloadManager*>(mgr)->clear( );
 	}
 
-	EXPORT int checkFileSHA1( const char *filename, const char *expected ) {
-		return DownloadManager::checkFileSHA1( std::string( filename ), std::string( expected ) );
+	EXPORT const char* getFileSHA1( const char *filename ) {
+		auto result = DownloadManager::getFileSHA1( std::string( filename ) );
+		if ( "" == result )
+			return NULL;
+
+		return result.c_str( );
 	}
 
-	EXPORT int checkStringSHA1( const char *string, const char *expected ) {
-		return DownloadManager::checkStringSHA1( std::string( string ), std::string( expected ) );
+	EXPORT const char* getStringSHA1( const char *string ) {
+		return DownloadManager::getStringSHA1( std::string( string ) ).c_str( );
 	}
 
 	EXPORT uint version( void ) {

threaded-libcurl/DownloadManagerC.h

@@ -15,19 +15,19 @@ struct CDlM;
 typedef struct CDlM CDlM;
 typedef unsigned int uint;
 
-EXPORT CDlM*       newDM          ( void );
-EXPORT uint        addDownload    ( CDlM *mgr,           const char *url,
-                             const char *outfile, const char *sha1 );
-EXPORT double      progress       ( CDlM *mgr );
-EXPORT int         busy           ( CDlM *mgr );
-EXPORT int         checkDownload  ( CDlM *mgr, uint i );
-EXPORT const char* getError       ( CDlM *mgr, uint i );
-EXPORT void        terminate      ( CDlM *mgr );
-EXPORT void        clear          ( CDlM *mgr );
-EXPORT int         checkFileSHA1  ( const char *filename, const char *expected );
-EXPORT int         checkStringSHA1( const char *string, const char *expected );
-EXPORT uint        version        ( void );
-EXPORT void        freeDM         ( CDlM *mgr );
+EXPORT CDlM*       newDM        ( void );
+EXPORT uint        addDownload  ( CDlM *mgr,           const char *url,
+                                  const char *outfile, const char *sha1 );
+EXPORT double      progress     ( CDlM *mgr );
+EXPORT int         busy         ( CDlM *mgr );
+EXPORT int         checkDownload( CDlM *mgr, uint i );
+EXPORT const char* getError     ( CDlM *mgr, uint i );
+EXPORT void        terminate    ( CDlM *mgr );
+EXPORT void        clear        ( CDlM *mgr );
+EXPORT const char* getFileSHA1  ( const char *filename );
+EXPORT const char* getStringSHA1( const char *string );
+EXPORT uint        version      ( void );
+EXPORT void        freeDM       ( CDlM *mgr );
 
 #ifdef __cplusplus
 }

threaded-libcurl/Downloader.cpp

@@ -1,5 +1,6 @@
 #include <iostream>
 #include <fstream>
+#include <sstream>
 #include <cstdint>
 #include <cstdio>
 
@@ -13,7 +14,7 @@ static int curlProgressCallback( void *userdata, curl_off_t dltotal, curl_off_t
 	return static_cast<Downloader*>(userdata)->progressCallback( dltotal, dlnow );
 }
 
-int sha1compare( uint8_t digest[SHA1_DIGEST_SIZE], const std::string sha1 ) {
+std::string digestToHex( uint8_t digest[SHA1_DIGEST_SIZE] ) {
 	char hash[41];
 	for( unsigned int offset = 0; offset < SHA1_DIGEST_SIZE; offset++ ) {
 #ifdef _WIN32
@@ -22,7 +23,7 @@ int sha1compare( uint8_t digest[SHA1_DIGEST_SIZE], const std::string sha1 ) {
 		snprintf( hash + 2*offset, 3, "%02x", digest[offset] );
 #endif // _WIN32
 	}
-	return (std::string(hash) != sha1);
+	return std::string(hash);
 }
 
 Downloader::Downloader( std::string theUrl, std::string theOutfile ) {
@@ -66,8 +67,11 @@ void Downloader::finalize( void ) {
 	if (hasSHA1) {
 		uint8_t digest[SHA1_DIGEST_SIZE];
 		SHA1_Final( &sha1ctx, digest );
-		if (sha1compare( digest, sha1 )) {
-			error = "sha1 mismatch.";
+		auto result = digestToHex( digest );
+		if ( result != sha1 ) {
+			std::ostringstream fmtStr("Hash mismatch. Got ");
+			fmtStr << result << ", expected " << sha1;
+			error = fmtStr.str( );
 			failed = true;
 			return;
 		}

threaded-libcurl/Downloader.hpp

@@ -5,7 +5,7 @@
 
 #include "sha1.h"
 
-int sha1compare( uint8_t digest[SHA1_DIGEST_SIZE], const std::string sha1 );
+std::string digestToHex( uint8_t digest[SHA1_DIGEST_SIZE] );
 
 class Downloader {
 	std::thread thread;