Merge pull request #5 from sharkwouter/add-get-resource-types

Allow getting named resources

Author: sharkwouter

CMakeLists.txt

@@ -50,7 +50,7 @@ endif(PE_STRING_LOADER AND (BUILD_SHARED_LIBS OR BUILD_STATIC_LIBS))
 
 option(PE_BITMAP_LOADER "If the pe_bitmap_loader program should be build as well" ON)
 if(PE_BITMAP_LOADER AND (BUILD_SHARED_LIBS OR BUILD_STATIC_LIBS))
-  add_executable(pe_bitmap_loader pe_bitmap_loader/main.c pe_bitmap_loader/stb_image_write.h)
+  add_executable(pe_bitmap_loader pe_bitmap_loader/main.c)
   target_include_directories(pe_bitmap_loader PRIVATE
     include/
   )
@@ -61,6 +61,19 @@ if(PE_BITMAP_LOADER AND (BUILD_SHARED_LIBS OR BUILD_STATIC_LIBS))
   endif()
 endif(PE_BITMAP_LOADER AND (BUILD_SHARED_LIBS OR BUILD_STATIC_LIBS))
 
+option(PE_RESOURCE_TYPES "If the pe_resource_types program should be build as well" OFF)
+if(PE_RESOURCE_TYPES AND (BUILD_SHARED_LIBS OR BUILD_STATIC_LIBS))
+  add_executable(pe_resource_types pe_resource_types/main.c)
+  target_include_directories(pe_resource_types PRIVATE
+    include/
+  )
+  if(BUILD_STATIC_LIBS)
+    target_link_libraries(pe_resource_types pe_resource_loader_static)
+  elseif(BUILD_SHARED_LIBS)
+    target_link_libraries(pe_resource_types pe_resource_loader_shared)
+  endif()
+endif(PE_RESOURCE_TYPES AND (BUILD_SHARED_LIBS OR BUILD_STATIC_LIBS))
+
 include(GNUInstallDirs)
 configure_file("${CMAKE_CURRENT_SOURCE_DIR}/pe-resource-loader.pc.in"
   "${CMAKE_CURRENT_BINARY_DIR}/lib/pkgconfig/pe-resource-loader.pc" @ONLY)
@@ -85,4 +98,8 @@ if (NOT WIN32)
   if(PE_BITMAP_LOADER)
     install(TARGETS pe_bitmap_loader DESTINATION bin)
   endif(PE_BITMAP_LOADER)
+
+  if(PE_RESOURCE_TYPES)
+    install(TARGETS pe_resource_types DESTINATION bin)
+  endif(PE_RESOURCE_TYPES)
 endif(NOT WIN32)

include/pe_resource_loader.h

@@ -20,6 +20,21 @@ typedef struct {
   uint32_t resource_offset;
 } PeResourceLoader;
 
+/**
+ * @brief Struct with the name and internal offset of a named resource.
+ *
+ * This struct should only be used to list names of resources and to pass along to other functions of pe-resource-loader.
+ *
+ * @param name_length The length of the name string.
+ * @param name The name of the name resource as string.
+ *
+ */
+typedef struct {
+  uint16_t name_length;
+  char *  name;
+  uint32_t  name_offset_or_id;
+} PRL_ResourceName;
+
 /**
  * @brief Open a PE file for retrieving resources.
  *
@@ -59,6 +74,7 @@ typedef enum {
   PRL_TYPE_ACCELERATOR=9,
   PRL_TYPE_RCDATA=10,
   PRL_TYPE_MESSAGETABLE=11,
+  PRL_TYPE_GROUPCURSOR=12,
   PRL_TYPE_GROUPICON=14,
   PRL_TYPE_VERSION=16,
   PRL_TYPE_DLGINCLUDE=17,
@@ -89,7 +105,17 @@ uint32_t * PeResourceLoader_GetLanguageIds(PeResourceLoader * loader, uint16_t *
  * @param count Will contain the size of returned array not NULL.
  * @return An array of resource IDs.
  */
-uint32_t * PeResourceLoader_GetResourceIds(PeResourceLoader *loader, PRL_Type resource_type, uint32_t * count);
+uint32_t * PeResourceLoader_GetResourceIds(PeResourceLoader *loader, PRL_Type resource_type, uint16_t * count);
+
+/**
+ * @brief Get a struct all resource IDs in the PE file.
+ *
+ * @param loader PeResourceLoader struct pointer created by PeResourceLoader_Open.
+ * @param resource_type The type of resource of which IDs should be returned.
+ * @param count Will contain the size of returned array not NULL.
+ * @return An array of PRL_ResourceName structs, containing the length of the name, the name and the name offset that can also be used as an id in some cases.
+ */
+PRL_ResourceName * PeResourceLoader_GetResourceNames(PeResourceLoader *loader, PRL_Type resource_type, uint16_t * count);
 
 /**
  * @brief Retrieve a resource from a PE file.
@@ -107,6 +133,31 @@ uint32_t * PeResourceLoader_GetResourceIds(PeResourceLoader *loader, PRL_Type re
  */
 void * PeResourceLoader_GetResource(PeResourceLoader * loader, PRL_Type resource_type, uint32_t language_id, uint32_t resource_id, uint32_t * size);
 
+/**
+ * @brief Retrieve a resource with a name instead of an id from a PE file.
+ *
+ * Headers will automatically be added to bitmaps, icons and cursors, making it possible to write them to disk as is.
+ * Strings will be automatically converted to UTF-8.
+ * Other types of resources will be returned as is.
+ *
+ * @param loader PeResourceLoader struct pointer created by PeResourceLoader_Open.
+ * @param resource_type The type of resource that is retrieved.
+ * @param language_id The ID of the language the resource should be returned in.
+ * @param resource_name The PRL_ResourceName struct returned by PeResourceLoader_GetResourceNames.
+ * @param size Will contain the size of the resource retrieved.
+ * @return The data contained in the resource as void pointer.
+ */
+void * PeResourceLoader_GetNamedResource(PeResourceLoader * loader, PRL_Type resource_type, uint32_t language_id, PRL_ResourceName * resource_name, uint32_t * size);
+
+/**
+ * @brief Get a list of all resource types found in a PE file.
+ *
+ * @param loader PeResourceLoader struct pointer created by PeResourceLoader_Open.
+ * @param resource_type_count Will contain the amount of resource types in the returned array.
+ * @return An array of resource type IDs.
+ */
+uint32_t * PeResourceLoader_GetResourceTypes(PeResourceLoader * loader, uint16_t * resource_type_count);
+
 /**
  * @brief Language IDs found in PE files.
  *

pe_bitmap_loader/main.c

@@ -3,9 +3,6 @@
 
 #include <pe_resource_loader.h>
 
-#define STB_IMAGE_WRITE_IMPLEMENTATION
-#include "stb_image_write.h"
-
 int main(int argc, char ** argv) {
   if (argc < 2) {
     printf("No file was defined\n");
@@ -22,14 +19,19 @@ int main(int argc, char ** argv) {
       continue;
     }
 
-    uint32_t bitmap_count = 0;
+    uint16_t bitmap_count = 0;
     uint32_t * bitmap_ids = PeResourceLoader_GetResourceIds(loader, PRL_TYPE_BITMAP, &bitmap_count);
-    if (bitmap_count == 0) {
+    uint16_t bitmap_name_count = 0;
+    PRL_ResourceName * bitmap_names = PeResourceLoader_GetResourceNames(loader, PRL_TYPE_BITMAP, &bitmap_name_count);
+    if (bitmap_count == 0 && bitmap_name_count == 0) {
       printf("No bitmaps found in file %s\n", argv[i]);
       PeResourceLoader_Close(loader);
       if (bitmap_ids) {
         free(bitmap_ids);
       }
+      if (bitmap_names) {
+        free(bitmap_names);
+      }
       return_value = 3;
       continue;
     }
@@ -42,6 +44,9 @@ int main(int argc, char ** argv) {
       if (bitmap_ids) {
         free(bitmap_ids);
       }
+      if (bitmap_names) {
+        free(bitmap_names);
+      }
       if (languages) {
         free(languages);
       }
@@ -52,22 +57,39 @@ int main(int argc, char ** argv) {
     for (uint16_t li = 0; li < language_count; li++) {
       printf("Language with id %u:\n", languages[li]);
       for (uint16_t bi = 0; bi < bitmap_count; bi++) {
-        printf("Found bitmap with id %u\n", bitmap_ids[bi]);
-        char * file_name = calloc(34, sizeof(char));
-        snprintf(file_name, 34, "%i_%u_%u.bmp", i, languages[li], bitmap_ids[bi]);
-        FILE * file = fopen(file_name, "wb");
-        free(file_name);
         uint32_t file_size = 0;
         void * data = PeResourceLoader_GetResource(loader, PRL_TYPE_BITMAP, languages[li], bitmap_ids[bi], &file_size);
-        printf("File size is %u\n", file_size);
-        fwrite(data, 1, file_size, file);
-        fclose(file);
-        free(data);
+        if (file_size > 0) {
+          char * file_name = calloc(32 + 32 + 5, sizeof(char));
+          snprintf(file_name, 32 + 32 + 5, "%u_%u.bmp", bitmap_ids[bi], languages[li]);
+          printf("Exporting file %s\n", file_name);
+          FILE * file = fopen(file_name, "wb");
+          free(file_name);
+          fwrite(data, 1, file_size, file);
+          fclose(file);
+        }
+        if (data != NULL)
+          free(data);
+      }
+      for (uint16_t bi = 0; bi < bitmap_name_count; bi++) {
+        uint32_t file_size = 0;
+        void * data = PeResourceLoader_GetNamedResource(loader, PRL_TYPE_BITMAP, languages[li], &bitmap_names[bi], &file_size);
+        if (file_size > 0) {
+          char * file_name = calloc(bitmap_names[bi].name_length + 32 + 4, sizeof(char));
+          snprintf(file_name, bitmap_names[bi].name_length + 32 + 4, "%s_%u.bmp", bitmap_names[bi].name, languages[li]);
+          printf("Exporting file %s\n", file_name);
+          FILE * file = fopen(file_name, "wb");
+          free(file_name);
+          fwrite(data, 1, file_size, file);
+          fclose(file);
+        }
+        if (data != NULL)
+          free(data);
       }
-      printf("\n");
     }
     free(languages);
     free(bitmap_ids);
+    free(bitmap_names);
 
     PeResourceLoader_Close(loader);
   }