[Issue #3871] File activation for unpackaged App would fail when file path contains unicode characters or special characters (#5175)

* Add special logic to use string operations for file uri parsing

* minor refactor to increase readability and simplify logic

* Add test

* refine comments

* Add description on error

Author: MuyuanMS

dev/AppLifecycle/ExtensionContract.h

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT License.
 #pragma once
 
@@ -52,6 +52,14 @@ namespace winrt::Microsoft::Windows::AppLifecycle::implementation
             }
         }
 
+        // QueryParsed() function would return empty when it's a file contract with unicode characters in file path
+        // Thus following additional check for file contract is needed
+        auto fileContractUri = GenerateEncodedLaunchUri(L"App", c_fileContractId);
+        if (CompareStringOrdinal(uri.AbsoluteUri().c_str(), fileContractUri.length(), fileContractUri.c_str(), -1, TRUE) == CSTR_EQUAL)
+        {
+            return { ExtendedActivationKind::File, FileActivatedEventArgs::Deserialize(uri) };
+        }
+
         return { ExtendedActivationKind::Protocol, nullptr };
     }
 }

dev/AppLifecycle/FileActivatedEventArgs.h

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT License.
 #pragma once
 
@@ -47,9 +47,46 @@ namespace winrt::Microsoft::Windows::AppLifecycle::implementation
 
         static winrt::Windows::Foundation::IInspectable Deserialize(winrt::Windows::Foundation::Uri const& uri)
         {
-            auto query = uri.QueryParsed();
-            auto verb = query.GetFirstValueByName(L"Verb");
-            auto file = query.GetFirstValueByName(L"File");
+            auto parsedQuery = uri.QueryParsed();
+
+            // By design parsed query should have a size of 3 (ContractId, Verb, File), in which case result from QueryParsed() can be used directly.
+            // However, it may have a size of 0 when uri contains unicode characters, or more than 3 when file path contains "&", which requires manual parsing with string functions.
+            if (parsedQuery.Size() == 3)
+            {
+                auto verb = parsedQuery.GetFirstValueByName(L"Verb");
+                auto file = parsedQuery.GetFirstValueByName(L"File");
+                return make<FileActivatedEventArgs>(verb, file);
+            }
+
+            const std::wstring query = uri.Query().c_str();
+            auto queryLength = query.length();
+
+            auto verbBegin = query.find(L"&Verb=");
+            if (verbBegin == std::wstring::npos)
+            {
+                throw winrt::hresult_invalid_argument(L"Query of encoded file protocol should contain 'Verb'");
+            }
+            verbBegin += 6; // Length of "&Verb="
+
+            auto verbEnd = query.find(L"&", verbBegin);
+            if (verbEnd == std::wstring::npos)
+            {
+                verbEnd = queryLength;
+            }
+
+            auto fileBegin = query.find(L"&File=");
+            if (fileBegin == std::wstring::npos)
+            {
+                throw winrt::hresult_invalid_argument(L"Query of encoded file protocol should contain 'File'");
+            }
+            fileBegin += 6; // Length of "&File="
+
+            // File path may contain '&' character, so fileEnd can only be assumed to be the end of the query or start of Verb
+            auto fileEnd = verbBegin > fileBegin ? verbBegin : queryLength;
+
+            auto verb = winrt::to_hstring(query.substr(verbBegin, verbEnd - verbBegin).c_str());
+            auto file = winrt::to_hstring(query.substr(fileBegin, fileEnd - fileBegin).c_str());
+
             return make<FileActivatedEventArgs>(verb, file);
         }
 

test/AppLifecycle/FunctionalTests.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT License.
 
 #include "pch.h"
@@ -29,6 +29,7 @@ namespace Test::AppLifecycle
         std::wstring m_testName;
 
         const std::wstring c_testDataFileName = L"testfile" + c_testFileExtension;
+        const std::wstring c_testDataFileName_Unicode = L"你好&世界" + c_testFileExtension;
         const std::wstring c_testDataFileName_Packaged = L"testfile" + c_testFileExtension_Packaged;
         const std::wstring c_testPackageFile = g_deploymentDir + L"AppLifecycleTestPackage.msix";
         const std::wstring c_testVCLibsPackageFile = g_deploymentDir + L"VCLibs.appx";
@@ -52,6 +53,7 @@ namespace Test::AppLifecycle
 
             // Write out some test content.
             WriteContentFile(c_testDataFileName);
+            WriteContentFile(c_testDataFileName_Unicode);
             WriteContentFile(c_testDataFileName_Packaged);
 
             return true;
@@ -63,6 +65,7 @@ namespace Test::AppLifecycle
             try
             {
                 DeleteContentFile(c_testDataFileName_Packaged);
+                DeleteContentFile(c_testDataFileName_Unicode);
                 DeleteContentFile(c_testDataFileName);
                 UninstallPackage(c_testPackageFullName);
             }
@@ -128,6 +131,42 @@ namespace Test::AppLifecycle
             WaitForEvent(event, m_failed);
         }
 
+        TEST_METHOD(GetActivatedEventArgsForUnicodeNamedFile_Win32)
+        {
+            // Create a named event for communicating with test app.
+            auto event = CreateTestEvent(c_testFilePhaseEventName);
+
+            // Cleanup any leftover data from previous runs i.e. ensure we running with a clean slate
+            try
+            {
+                Execute(L"AppLifecycleTestApp.exe", L"/UnregisterFile", g_deploymentDir);
+                WaitForEvent(event, m_failed);
+            }
+            catch (...)
+            {
+                //TODO:Unregister should not fail if ERROR_FILE_NOT_FOUND | ERROR_PATH_NOT_FOUND
+            }
+
+            // Launch the test app to register for protocol launches.
+            Execute(L"AppLifecycleTestApp.exe", L"/RegisterFile", g_deploymentDir);
+
+            // Wait for the register event.
+            WaitForEvent(event, m_failed);
+
+            // Launch the file and wait for the event to fire.
+            auto file = OpenDocFile(c_testDataFileName_Unicode);
+            auto launchResult = Launcher::LaunchFileAsync(file).get();
+            VERIFY_IS_TRUE(launchResult);
+
+            // Wait for the file activation.
+            WaitForEvent(event, m_failed);
+
+            Execute(L"AppLifecycleTestApp.exe", L"/UnregisterFile", g_deploymentDir);
+
+            // Wait for the unregister event.
+            WaitForEvent(event, m_failed);
+        }
+
         TEST_METHOD(GetActivatedEventArgsForFile_PackagedWin32)
         {
             // Create a named event for communicating with test app.