Implemented WindowsIconResolutionService class as main implementation for IIconResolutionService. #167

end2endzone · end2endzone · commit a2f94d5f6e63 · 2024-08-26T15:58:24.000-04:00
diff --git a/src/shellextension/dllmain.cpp b/src/shellextension/dllmain.cpp
@@ -39,7 +39,7 @@
 #include "WindowsClipboardService.h"
 #include "WindowsKeyboardService.h"
 #include "PcgRandomService.h"
-#include "LegacyIconResolutionService.h"
+#include "WindowsIconResolutionService.h"
 
 #include "shellanything/version.h"
 #include "shellanything/config.h"
@@ -201,7 +201,7 @@ extern "C" int APIENTRY DllMain(HINSTANCE hInstance, DWORD dwReason, LPVOID lpRe
       app.SetRandomService(random_service);
 
       // Setup an active icon resolution service in ShellAnything's core.
-      icon_resolution_service = new shellanything::LegacyIconResolutionService();
+      icon_resolution_service = new shellanything::WindowsIconResolutionService();
       app.SetIconResolutionService(icon_resolution_service);
 
       // Setup and starting application
diff --git a/src/tests/TestIcon.cpp b/src/tests/TestIcon.cpp
@@ -263,7 +263,15 @@ namespace shellanything
           ASSERT_TRUE(read) << "Failed to read log file: " << path;
 
           int count = CountString(content, UNKNOWN_FILE_EXTENSION);
-          static const int MAX_COUNT = 2; // Issue 167. A maximum of 2 reference is allowed. One from LegacyIconResolutionService class and another from Icon::ResolveFileExtensionIcon().
+
+          // Define how many reference we should see in log file.
+          // With LegacyIconResolutionService class as active service, a maximum of 2 reference is allowed:
+          // One from LegacyIconResolutionService class and another from Icon::ResolveFileExtensionIcon().
+          // 
+          // With WindowsIconResolutionService class as active service, a maximum of 3 reference is allowed:
+          // Two from WindowsIconResolutionService class and another from Icon::ResolveFileExtensionIcon().
+          static const int MAX_COUNT = 3; // Issue #18. Issue #167.
+
           ASSERT_LE(count, MAX_COUNT) << "Log file '" << path << "' contains " << count << " references to '" << UNKNOWN_FILE_EXTENSION << "'.";
         }
       }
diff --git a/src/tests/main.cpp b/src/tests/main.cpp
@@ -50,7 +50,7 @@
 #include "WindowsClipboardService.h"
 #include "TestKeyboardService.h"
 #include "PcgRandomService.h"
-#include "LegacyIconResolutionService.h"
+#include "WindowsIconResolutionService.h"
 #include "ConfigManager.h"
 
 using namespace ra;
@@ -149,7 +149,7 @@ int main(int argc, char** argv)
   app.SetRandomService(random_service);
 
   // Setup an active icon resolution service in ShellAnything's core.
-  shellanything::IIconResolutionService* icon_resolution_service = new shellanything::LegacyIconResolutionService();
+  shellanything::IIconResolutionService* icon_resolution_service = new shellanything::WindowsIconResolutionService();
   app.SetIconResolutionService(icon_resolution_service);
 
   //Issue #60 - Unit tests cannot execute from installation directory.
diff --git a/src/windows/CMakeLists.txt b/src/windows/CMakeLists.txt
@@ -6,6 +6,8 @@ add_library(sa.windows SHARED
   Win32Clipboard.h
   WindowsClipboardService.cpp
   WindowsClipboardService.h
+  WindowsIconResolutionService.cpp
+  WindowsIconResolutionService.h
   WindowsRegistryService.cpp
   WindowsRegistryService.h
   WindowsKeyboardService.cpp
diff --git a/src/windows/WindowsIconResolutionService.cpp b/src/windows/WindowsIconResolutionService.cpp
@@ -0,0 +1,191 @@
+/**********************************************************************************
+ * MIT License
+ *
+ * Copyright (c) 2018 Antoine Beauchamp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#include "WindowsIconResolutionService.h"
+#include "PropertyManager.h"
+#include "SelectionContext.h"
+#include "LoggerHelper.h"
+#include "App.h"
+#include "SaUtils.h"
+#include "Win32Registry.h"
+
+#include "rapidassist/strings.h"
+#include "rapidassist/environment.h"
+#include "rapidassist/filesystem_utf8.h"
+#include "rapidassist/unicode.h"
+
+#include <Windows.h>
+
+namespace shellanything
+{
+  WindowsIconResolutionService::WindowsIconResolutionService()
+  {
+  }
+
+  WindowsIconResolutionService::~WindowsIconResolutionService()
+  {
+  }
+
+  bool WindowsIconResolutionService::ResolveFileExtensionIcon(Icon& icon)
+  {
+    // Is this icon have a file extension ?
+    std::string original_file_extension = icon.GetFileExtension();
+    if (original_file_extension.empty())
+      return false; //nothing to resolve
+
+    shellanything::PropertyManager& pmgr = shellanything::PropertyManager::GetInstance();
+    std::string file_extension = pmgr.Expand(original_file_extension);
+    if (file_extension.empty())
+      return false; //nothing to resolve
+
+    // Check for multiple values. Keep the first value, forget about other selected file extensions.
+    const std::string separator = pmgr.GetProperty(SelectionContext::MULTI_SELECTION_SEPARATOR_PROPERTY_NAME);
+    if (file_extension.find(separator) != std::string::npos)
+    {
+      //multiple values detected.
+      ra::strings::StringVector extension_list = ra::strings::Split(file_extension, separator.c_str());
+      if (!extension_list.empty())
+        file_extension = extension_list[0];
+    }
+
+    // Search within previous resolutions
+    IconResolutionInfoMap::const_iterator mapIt = mResolutions.find(file_extension);
+    bool found = (mapIt != mResolutions.end());
+    if (found)
+    {
+      const ICON_RESOLUTION_INFO& resolution = mapIt->second;
+      icon.SetPath(resolution.path);
+      icon.SetIndex(resolution.index);
+      icon.SetFileExtension("");
+      return true;
+    }
+
+    // Generate an empty file with the required file extension
+    IRandomService* random_service = App::GetInstance().GetRandomService();
+    if (random_service == NULL)
+    {
+      SA_LOG(ERROR) << "No Random service configured for resolving file extensions to icon.";
+      return false;
+    }
+
+    SA_LOG(INFO) << "Resolving icon for file extension '" << file_extension << "'.";
+
+    // Generate a random filename in %TEMP% directory
+    std::string temp_file_path;
+    temp_file_path += ra::filesystem::GetTemporaryDirectoryUtf8();
+    temp_file_path += ra::filesystem::GetPathSeparatorStr();
+    temp_file_path += "icon_resolution"; // file prefix
+    temp_file_path += ra::strings::ToString(random_service->GetRandomValue(10000,99999));
+    temp_file_path += "."; // file postfix
+    temp_file_path += file_extension;
+
+    // Create a blank file
+    bool file_created = ra::filesystem::WriteFileUtf8(temp_file_path, file_extension);
+    if (!file_created)
+    {
+      SA_LOG(ERROR) << "Failed to create sample file '" << temp_file_path << "' to resolve icon for file extension '" << file_extension << "'.";
+      mFailures.insert(file_extension);
+      return false;
+    }
+
+    std::wstring temp_file_path_wide = ra::unicode::Utf8ToUnicode(temp_file_path);
+
+    // Try to get an actual icon
+    HINSTANCE hInstance = GetModuleHandle(NULL);
+    wchar_t buffer[2 * MAX_PATH];
+    wsprintfW(buffer, L"%s", temp_file_path_wide.c_str());
+    WORD official_index = 0;
+    WORD official_id = 0;
+    HICON hIcon = ExtractAssociatedIconExW(hInstance, buffer, &official_index, &official_id);
+    std::wstring official_file_path_wide = buffer;
+
+    // Clean up
+    ra::filesystem::DeleteFileUtf8(temp_file_path.c_str());
+    if (hIcon)
+      DestroyIcon(hIcon);
+
+    // Did we failed resolution?
+    if (hIcon == NULL || official_file_path_wide == temp_file_path_wide)
+    {
+      DWORD dwLastError = GetLastError();
+      Win32Registry::REGISTRY_ICON unknown_file_icon = Win32Registry::GetUnknownFileTypeIcon();
+      SA_LOG(ERROR) <<
+        "Failed to find icon for file extension '" << file_extension << "' with ExtractAssociatedIconExW(). GetLastError(): " << ToHexString(dwLastError) << ". "
+        "Resolving icon with default icon for unknown file type '" << unknown_file_icon.path << "' with index '" << unknown_file_icon.index << "'";
+
+      // Remember this result
+      ICON_RESOLUTION_INFO info;
+      info.path = unknown_file_icon.path;
+      info.index = unknown_file_icon.index;
+      info.id = -1;
+      ResolveWith(icon, file_extension, info);
+
+      // But also remember that its not a true resolution
+      mFailures.insert(file_extension);
+
+      return true;
+    }
+
+    // Remember this result
+    ICON_RESOLUTION_INFO info;
+    info.path = ra::unicode::UnicodeToUtf8(official_file_path_wide);
+    info.index = official_index;
+    info.id = official_id;
+    ResolveWith(icon, file_extension, info);
+
+    SA_LOG(INFO) << "Resolved icon for file extension '" << file_extension << "' to file '" << info.path << "' with index '" << info.index << "'";
+
+    return true;
+  }
+
+  bool WindowsIconResolutionService::HaveResolvedBefore(const std::string& file_extension) const
+  {
+    IconResolutionInfoMap::const_iterator mapIt = mResolutions.find(file_extension);
+    bool found = (mapIt != mResolutions.end());
+    if (found)
+      return true;
+
+    // or did we resolved as a failure ?
+    found = HaveFailedBefore(file_extension);
+    return found;
+  }
+
+  bool WindowsIconResolutionService::HaveFailedBefore(const std::string& file_extension) const
+  {
+    bool have_failed_before = mFailures.find(file_extension) != mFailures.end();
+    return have_failed_before;
+  }
+
+  void WindowsIconResolutionService::ResolveWith(Icon& icon, const std::string& file_extension, const ICON_RESOLUTION_INFO& info)
+  {
+    icon.SetPath(info.path);
+    icon.SetIndex(info.index);
+    icon.SetFileExtension("");
+
+    // Remember this result
+    mResolutions[file_extension] = info;
+  }
+
+
+} //namespace shellanything
diff --git a/src/windows/WindowsIconResolutionService.h b/src/windows/WindowsIconResolutionService.h
@@ -0,0 +1,98 @@
+/**********************************************************************************
+ * MIT License
+ *
+ * Copyright (c) 2018 Antoine Beauchamp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#ifndef SA_WINDOWS_ICON_RESOLUTION_SERVICE_H
+#define SA_WINDOWS_ICON_RESOLUTION_SERVICE_H
+
+#include "sa_windows_export.h"
+#include "IIconResolutionService.h"
+
+#include <map>
+
+namespace shellanything
+{
+  /// <summary>
+  /// Windows implementation class of IIconResolutionService that resolves icon based on ExtractAssociatedIconEx().
+  /// </summary>
+  class SA_WINDOWS_EXPORT WindowsIconResolutionService : public virtual IIconResolutionService
+  {
+  public:
+    WindowsIconResolutionService();
+    virtual ~WindowsIconResolutionService();
+
+  private:
+    // Disable and copy constructor, dtor and copy operator
+    WindowsIconResolutionService(const WindowsIconResolutionService&);
+    WindowsIconResolutionService& operator=(const WindowsIconResolutionService&);
+  public:
+
+    /// <summary>
+    /// Resolve an icon's file extension to the system icon for this file extension.
+    /// </summary>
+    /// <param name="icon">The icon that have its fileextension's attribute set to resolve.</param>
+    /// <returns>Returns true if the operation is successful. Returns false otherwise.</returns>
+    virtual bool ResolveFileExtensionIcon(Icon& icon);
+
+    /// <summary>
+    /// Check if the given file extension have resolved before.
+    /// </summary>
+    /// <param name="file_entension">The file extension to check.</param>
+    /// <returns>Returns true if the file extension has previously resolve to a valid icon. Returns false otherwise.</returns>
+    virtual bool HaveResolvedBefore(const std::string& file_extension) const;
+
+    /// <summary>
+    /// Check if the given file extension have previously failed to resolve.
+    /// </summary>
+    /// <param name="file_extension">The file extension to check.</param>
+    /// <returns>Returns true if the file extension has previously failed to resolve. Returns false otherwise.</returns>
+    virtual bool HaveFailedBefore(const std::string& file_extension) const;
+
+  private:
+    //------------------------
+    // Typedef
+    //------------------------
+    struct ICON_RESOLUTION_INFO
+    {
+      std::string path;
+      int index;
+      int id;
+    };
+
+    /// <summary>
+    /// Resolve an icon's with the given ICON_RESOLUTION_INFO.
+    /// </summary>
+    /// <param name="icon">The icon that have its fileextension's attribute set to resolve.</param>
+    /// <param name="file_extension">The file extension specified by the icon.</param>
+    /// <param name="info">The infomation to resolve the icon with.</param>
+    void ResolveWith(Icon& icon, const std::string & file_extension, const ICON_RESOLUTION_INFO & info);
+
+    typedef std::map<std::string /*file extension*/, ICON_RESOLUTION_INFO /*info*/> IconResolutionInfoMap;
+    typedef std::set<std::string /*file extension*/> FileExtensionSet;
+    IconResolutionInfoMap mResolutions;
+    FileExtensionSet mFailures;
+  };
+
+} //namespace shellanything
+
+#endif //SA_WINDOWS_ICON_RESOLUTION_SERVICE_H
