Opening storage can now be cancelled via progress callback

Author: Ladislav Zezula

src/CascCommon.h

@@ -206,10 +206,12 @@ struct TCascStorage
 
     static TCascStorage * IsValid(HANDLE hStorage);
 
+    PFNPROGRESSCALLBACK PfnCallback;                // Callback to be called during CascOpen(Online)Storage
+    void * PtrCallbackParam;
+
     const TCHAR * szIndexFormat;                    // Format of the index file name
     const char * szClassName;                       // "TCascStorage"
     const char * szProductName;                     // String representation of the product name
-    const char * szErrorMsg;                        // If not NULL, contains the error message string
     TCHAR * szRootPath;                             // Path where the build file is
     TCHAR * szDataPath;                             // This is the directory where data files are
     TCHAR * szIndexPath;                            // This is the directory where index files are

src/CascFiles.cpp

@@ -1209,11 +1209,14 @@ int LoadBuildInfo(TCascStorage * hs)
     // If the storage is online storage, we need to download "versions"
     if(hs->dwFeatures & CASC_FEATURE_ONLINE)
     {
+        // Inform the user about loading the build.info/build.db/versions
+        if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Downloading the \"versions\" file", NULL, 0, 0))
+            return ERROR_CANCELLED;
+
         // Attempt to download the "versions" file
         nError = DownloadFile(hs, _T("us.patch.battle.net"), hs->szCodeName, _T("versions"), NULL, NULL, 0, NULL, 0, STREAM_FLAG_USE_PORT_1119, true, false);
         if(nError != ERROR_SUCCESS)
         {
-            hs->szErrorMsg = "Error downloading \"versions\"";
             return nError;
         }
     }
@@ -1248,7 +1251,11 @@ int LoadCdnsInfo(TCascStorage * hs)
 
     // Sanity checks
     assert(hs->dwFeatures & CASC_FEATURE_ONLINE);
-    
+
+    // Inform the user about what we are doing
+    if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Downloading the \"cdns\" file", NULL, 0, 0))
+        return ERROR_CANCELLED;
+
     // Download file and parse it
     nError = DownloadFile(hs, _T("us.patch.battle.net"), hs->szCodeName, _T("cdns"), NULL, NULL, 0, szLocalPath, _countof(szLocalPath), STREAM_FLAG_USE_PORT_1119, false, true);
     if(nError == ERROR_SUCCESS)
@@ -1264,17 +1271,23 @@ int LoadCdnConfigFile(TCascStorage * hs)
     // The CKey for the CDN config should have been loaded already
     assert(hs->CdnConfigKey.pbData != NULL && hs->CdnConfigKey.cbData == MD5_HASH_SIZE);
 
-    // Load the CDN config file. Note that we don't
-    // need it for anything, really, so we don't care if it fails
-    FetchAndLoadConfigFile(hs, &hs->CdnConfigKey, ParseFile_CdnConfig);
-    return ERROR_SUCCESS;
+    // Inform the user about what we are doing
+    if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Downloading CDN config file", NULL, 0, 0))
+        return ERROR_CANCELLED;
+
+    // Load the CDN config file
+    return FetchAndLoadConfigFile(hs, &hs->CdnConfigKey, ParseFile_CdnConfig);
 }
 
 int LoadCdnBuildFile(TCascStorage * hs)
 {
     // The CKey for the CDN config should have been loaded already
     assert(hs->CdnBuildKey.pbData != NULL && hs->CdnBuildKey.cbData == MD5_HASH_SIZE);
 
+    // Inform the user about what we are doing
+    if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Downloading CDN build file", NULL, 0, 0))
+        return ERROR_CANCELLED;
+
     // Load the CDN config file. Note that we don't
     // need it for anything, really, so we don't care if it fails
     return FetchAndLoadConfigFile(hs, &hs->CdnBuildKey, ParseFile_CdnBuild);

src/CascIndexFiles.cpp

@@ -1,13 +1,11 @@
 /*****************************************************************************/
-/* CascOpenStorage.cpp                    Copyright (c) Ladislav Zezula 2014 */
+/* CascIndexFiles.cpp                     Copyright (c) Ladislav Zezula 2019 */
 /*---------------------------------------------------------------------------*/
-/* Storage functions for CASC                                                */
-/* Note: WoW6 offsets refer to WoW.exe 6.0.3.19116 (32-bit)                  */
-/* SHA1: c10e9ffb7d040a37a356b96042657e1a0c95c0dd                            */
+/* Index file support                                                        */
 /*---------------------------------------------------------------------------*/
 /*   Date    Ver   Who  Comment                                              */
 /* --------  ----  ---  -------                                              */
-/* 29.04.14  1.00  Lad  The first version of CascOpenStorage.cpp             */
+/* 23.05.19  1.00  Lad  Created                                              */
 /*****************************************************************************/
 
 #define __CASCLIB_SELF__
@@ -523,6 +521,14 @@ static int LoadLocalIndexFiles(TCascStorage * hs)
                 // Create the name of the index file
                 if((szFileName = CreateIndexFileName(hs, i, IndexArray[i])) != NULL)
                 {
+                    // Inform the user about what we are doing
+                    if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Loading index files", NULL, i, CASC_INDEX_COUNT))
+                    {
+                        nError = ERROR_CANCELLED;
+                        break;
+                    }
+
+                    // Load the index file
                     if((nError = LoadIndexFile(hs, szFileName, i)) != ERROR_SUCCESS)
                         break;
                     CASC_FREE(szFileName);
@@ -707,6 +713,7 @@ static int LoadArchiveIndexFiles(TCascStorage * hs)
     LPBYTE pbFileData;
     TCHAR szLocalPath[MAX_PATH];
     DWORD cbFileData = 0;
+    size_t nArchiveCount = (hs->ArchivesKey.cbData / MD5_HASH_SIZE);
     int nError = ERROR_SUCCESS;
 
     // Create the array object for the indices
@@ -715,9 +722,16 @@ static int LoadArchiveIndexFiles(TCascStorage * hs)
         return nError;
 
     // Load all the indices
-    for (size_t i = 0; i < hs->ArchivesKey.cbData; i += MD5_HASH_SIZE)
+    for (size_t i = 0; i < nArchiveCount; i++)
     {
-        LPBYTE pbIndexHash = hs->ArchivesKey.pbData + i;
+        LPBYTE pbIndexHash = hs->ArchivesKey.pbData + (i * MD5_HASH_SIZE);
+
+        // Inform the user about what we are doing
+        if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Downloading archive indexes", NULL, (DWORD)(i), (DWORD)(nArchiveCount)))
+        {
+            nError = ERROR_CANCELLED;
+            break;
+        }
 
         // Make sure that we have local copy of the file
         nError = DownloadFileFromCDN(hs, _T("data"), pbIndexHash, _T(".index"), szLocalPath, _countof(szLocalPath));

src/CascLib.h

@@ -287,10 +287,22 @@ typedef struct _CASC_FILE_FULL_INFO
 } CASC_FILE_FULL_INFO, *PCASC_FILE_FULL_INFO;
 
 //-----------------------------------------------------------------------------
-// Callback functions
-
-typedef struct TFileStream TFileStream;
-typedef void (WINAPI * STREAM_DOWNLOAD_CALLBACK)(void * pvUserData, ULONGLONG ByteOffset, DWORD dwTotalBytes);
+// Some operations (e.g. opening an online storage) may take long time.
+// This callback allows an application to be notified about loading progress.
+// This callback only works for a single CascOpen(Online)Storage call.
+
+typedef bool (WINAPI * PFNPROGRESSCALLBACK)(    // Return 'true' to cancel the loading process
+    void * PtrUserParam,                        // User-specific parameter passed to the callback
+    LPCSTR szWork,                              // Text for the current activity (example: "Loading "ENCODING" file")
+    LPCSTR szObject,                            // (optional) name of the object tied to the activity (example: index file name)
+    DWORD nCurrent,                             // (optional) current object being processed
+    DWORD nTotal                                // (optional) If non-zero, this is the total number of objects to process
+    );
+
+void WINAPI CascSetProgressCallback(
+    PFNPROGRESSCALLBACK PtrUserCallback,        // Pointer to the callback function that will be called during opening the storage
+    void * PtrUserParam                         // Arbitrary user parameter that will be passed to the callback
+    );
 
 //-----------------------------------------------------------------------------
 // Functions for storage manipulation

src/CascOpenStorage.cpp

@@ -20,6 +20,12 @@
 // Limit for "orphaned" items - those that are in index files, but are not in ENCODING manifest
 #define CASC_MAX_ORPHANED_ITEMS 0x100
 
+//-----------------------------------------------------------------------------
+// Local variables
+
+static PFNPROGRESSCALLBACK PfnProgressCallback = NULL;
+static void * PtrProgressParam = NULL;
+
 //-----------------------------------------------------------------------------
 // TCascStorage service functions
 
@@ -32,7 +38,7 @@ TCascStorage::TCascStorage()
     dwRefCount = 1;
 
     szRootPath = szDataPath = szIndexPath = szBuildFile = szCdnServers = szCdnPath = szCodeName = NULL;
-    szProductName = szErrorMsg = NULL;
+    szProductName = NULL;
     szIndexFormat = NULL;
     szRegion = NULL;
 
@@ -44,6 +50,12 @@ TCascStorage::TCascStorage()
     BuildFileType = CascBuildNone;
 
     LocalFiles = TotalFiles = EKeyEntries = OrphanItems = SkippedItems = EKeyLength = FileOffsetBits = 0;
+
+    // Take the callback param and data. Zero the global pointers
+    PfnCallback = PfnProgressCallback;
+    PtrCallbackParam = PtrProgressParam;
+    PfnProgressCallback = NULL;
+    PtrProgressParam = NULL;
 }
 
 TCascStorage::~TCascStorage()
@@ -401,6 +413,10 @@ static int LoadEncodingManifest(TCascStorage * hs)
     DWORD cbEncodingFile = 0;
     int nError = ERROR_SUCCESS;
 
+    // Inform the user about what we are doing
+    if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Loading ENCODING manifest", NULL, 0, 0))
+        return ERROR_CANCELLED;
+
     // Load the entire encoding file to memory
     pbEncodingFile = LoadInternalFileToMemory(hs, &hs->EncodingCKey, &cbEncodingFile);
     if(pbEncodingFile != NULL && cbEncodingFile != 0)
@@ -728,6 +744,10 @@ static int LoadDownloadManifest(TCascStorage * hs)
     DWORD cbDownloadFile = 0;
     int nError = ERROR_SUCCESS;
 
+    // Inform the user about what we are doing
+    if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Loading DOWNLOAD manifest", NULL, 0, 0))
+        return ERROR_CANCELLED;
+
     // Load the entire DOWNLOAD file to memory
     pbDownloadFile = LoadInternalFileToMemory(hs, pCKeyEntry, &cbDownloadFile);
     if(pbDownloadFile != NULL && cbDownloadFile != 0)
@@ -761,6 +781,10 @@ static int LoadInstallManifest(TCascStorage * hs)
     DWORD cbInstallFile = 0;
     int nError = ERROR_SUCCESS;
 
+    // Inform the user about what we are doing
+    if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Loading INSTALL manifest", NULL, 0, 0))
+        return ERROR_CANCELLED;
+
     // Load the entire DOWNLOAD file to memory
     pbInstallFile = LoadInternalFileToMemory(hs, pCKeyEntry, &cbInstallFile);
     if (pbInstallFile != NULL && cbInstallFile != 0)
@@ -818,7 +842,11 @@ static int LoadBuildManifest(TCascStorage * hs, DWORD dwLocaleMask)
     pCKeyEntry = (hs->VfsRoot.ContentSize != CASC_INVALID_SIZE) ? &hs->VfsRoot : &hs->RootFile;
     pCKeyEntry = FindCKeyEntry_CKey(hs, pCKeyEntry->CKey);
 
-    // Load the entire ROOT file to memory. Ignore 
+    // Inform the user about what we are doing
+    if(hs->PfnCallback && hs->PfnCallback(hs->PtrCallbackParam, "Loading ROOT manifest", NULL, 0, 0))
+        return ERROR_CANCELLED;
+
+    // Load the entire ROOT file to memory
     pbRootFile = LoadInternalFileToMemory(hs, pCKeyEntry, &cbRootFile);
     if(pbRootFile != NULL)
     {
@@ -1134,6 +1162,12 @@ static int LoadCascStorage(TCascStorage * hs, DWORD dwLocaleMask)
 //-----------------------------------------------------------------------------
 // Public functions
 
+void WINAPI CascSetProgressCallback(PFNPROGRESSCALLBACK PtrUserCallback, void * PtrUserParam)
+{
+    PfnProgressCallback = PtrUserCallback;
+    PtrProgressParam = PtrUserParam;
+}
+
 bool WINAPI CascOpenStorage(LPCTSTR szPath, DWORD dwLocaleMask, HANDLE * phStorage)
 {
     TCascStorage * hs;

src/CascPort.h

@@ -250,7 +250,11 @@
 #ifndef ERROR_BUFFER_OVERFLOW
 #define ERROR_BUFFER_OVERFLOW            1008
 #endif
-  
+
+#ifndef ERROR_CANCELLED
+#define ERROR_CANCELLED                  1009
+#endif
+
 #ifndef _countof
 #define _countof(x)   (sizeof(x) / sizeof(x[0]))  
 #endif

src/common/FileStream.h

@@ -103,6 +103,12 @@ typedef void (*BLOCK_SAVEMAP)(
     struct TFileStream * pStream        // Pointer to a block-oriented stream
     );
 
+typedef void (WINAPI * STREAM_DOWNLOAD_CALLBACK)(
+    void * pvUserData,
+    ULONGLONG ByteOffset,
+    DWORD dwTotalBytes
+    );
+
 //-----------------------------------------------------------------------------
 // Local structures - partial file structure and bitmap footer