Skip to content

ApplicationData: Optimize *Path properties #6731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Howard Kapustein (DrusTheAxe) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ApplicationData: Optimize *Path properties #6731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 68 additions & 8 deletions dev/ApplicationData/M.W.S.ApplicationData.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@

#include "Validate.h"

namespace wil
{
typedef unique_any<::ApplicationDataState, decltype(&::ApplicationData_Close), ::ApplicationData_Close> unique_application_data_state;
}

static_assert(static_cast<int32_t>(winrt::Microsoft::Windows::Storage::ApplicationDataLocality::Local) == static_cast<int32_t>(winrt::Windows::Storage::ApplicationDataLocality::Local));
static_assert(static_cast<int32_t>(winrt::Microsoft::Windows::Storage::ApplicationDataLocality::LocalCache) == static_cast<int32_t>(winrt::Windows::Storage::ApplicationDataLocality::LocalCache));
static_assert(static_cast<int32_t>(winrt::Microsoft::Windows::Storage::ApplicationDataLocality::SharedLocal) == static_cast<int32_t>(winrt::Windows::Storage::ApplicationDataLocality::SharedLocal));
Expand Down Expand Up @@ -118,15 +123,39 @@ namespace winrt::Microsoft::Windows::Storage::implementation
{
return winrt::hstring{};
}
return StorageFolderToPath(m_applicationData.LocalCacheFolder());

wil::unique_application_data_state applicationDataState{ OpenApplicationData() };
WCHAR path[MAX_PATH]{};
UINT32 pathLength{ ARRAYSIZE(path) };
const HRESULT hr{ ApplicationData_GetLocalCachePath(applicationDataState.get(), &pathLength, path) };
if (SUCCEEDED(hr))
{
return winrt::hstring{ path };
}
THROW_HR_IF_MSG(hr, hr != HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), "%ls", m_packageFamilyName.c_str());
auto longPath{ std::make_unique<WCHAR[]>(pathLength) };
THROW_IF_FAILED_MSG(ApplicationData_GetLocalCachePath(applicationDataState.get(), &pathLength, path), "%ls", m_packageFamilyName.c_str());
return winrt::hstring(longPath.get());
}
hstring ApplicationData::LocalPath()
{
if (!m_applicationData)
{
return winrt::hstring{};
}
return StorageFolderToPath(m_applicationData.LocalFolder());

wil::unique_application_data_state applicationDataState{ OpenApplicationData() };
WCHAR path[MAX_PATH]{};
UINT32 pathLength{ ARRAYSIZE(path) };
const HRESULT hr{ ApplicationData_GetLocalPath(applicationDataState.get(), &pathLength, path) };
if (SUCCEEDED(hr))
{
return winrt::hstring{ path };
}
THROW_HR_IF_MSG(hr, hr != HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), "%ls", m_packageFamilyName.c_str());
auto longPath{ std::make_unique<WCHAR[]>(pathLength) };
THROW_IF_FAILED_MSG(ApplicationData_GetLocalPath(applicationDataState.get(), &pathLength, path), "%ls", m_packageFamilyName.c_str());
return winrt::hstring(longPath.get());
}
hstring ApplicationData::MachinePath()
{
Expand Down Expand Up @@ -157,7 +186,19 @@ namespace winrt::Microsoft::Windows::Storage::implementation
{
return winrt::hstring{};
}
return StorageFolderToPath(m_applicationData.TemporaryFolder());

wil::unique_application_data_state applicationDataState{ OpenApplicationData() };
WCHAR path[MAX_PATH]{};
UINT32 pathLength{ ARRAYSIZE(path) };
const HRESULT hr{ ApplicationData_GetTemporaryPath(applicationDataState.get(), &pathLength, path) };
if (SUCCEEDED(hr))
{
return winrt::hstring{ path };
}
THROW_HR_IF_MSG(hr, hr != HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), "%ls", m_packageFamilyName.c_str());
auto longPath{ std::make_unique<WCHAR[]>(pathLength) };
THROW_IF_FAILED_MSG(ApplicationData_GetTemporaryPath(applicationDataState.get(), &pathLength, path), "%ls", m_packageFamilyName.c_str());
return winrt::hstring(longPath.get());
}
winrt::Windows::Storage::StorageFolder ApplicationData::LocalCacheFolder()
{
Expand Down Expand Up @@ -241,13 +282,23 @@ namespace winrt::Microsoft::Windows::Storage::implementation
}
hstring ApplicationData::GetPublisherCachePath(hstring const& folderName)
{
auto folder{ GetPublisherCacheFolder(folderName) };
winrt::hstring path;
if (folder)
if (!m_applicationData)
{
path = folder.Path();
return winrt::hstring{};
}
return path;

wil::unique_application_data_state applicationDataState{ OpenApplicationData() };
WCHAR path[MAX_PATH]{};
UINT32 pathLength{ ARRAYSIZE(path) };
const HRESULT hr{ ApplicationData_GetPublisherCachePath(applicationDataState.get(), folderName.c_str(), &pathLength, path)};
if (SUCCEEDED(hr))
{
return winrt::hstring{ path };
}
THROW_HR_IF_MSG(hr, hr != HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), "%ls", m_packageFamilyName.c_str());
auto longPath{ std::make_unique<WCHAR[]>(pathLength) };
THROW_IF_FAILED_MSG(ApplicationData_GetPublisherCachePath(applicationDataState.get(), folderName.c_str(), &pathLength, path), "%ls", m_packageFamilyName.c_str());
return winrt::hstring(longPath.get());
}
winrt::Windows::Storage::StorageFolder ApplicationData::GetPublisherCacheFolder(hstring const& folderName)
{
Expand Down Expand Up @@ -331,4 +382,13 @@ namespace winrt::Microsoft::Windows::Storage::implementation
THROW_HR_IF_MSG(E_INVALIDARG, ::Microsoft::Foundation::String::IsNullOrEmpty(string.c_str()), "Product not valid (%ls)", string.c_str());
THROW_HR_IF_MSG(E_INVALIDARG, ::Microsoft::Windows::Storage::is_prohibited_string(string.c_str()), "Product not valid (%ls)", string.c_str());
}

::ApplicationDataState ApplicationData::OpenApplicationData()
{
auto tokenUser{ wil::get_token_information<TOKEN_USER>(GetCurrentProcessToken()) };
PSID userSid{ tokenUser->User.Sid };
::ApplicationDataState applicationDataState{};
THROW_IF_FAILED(::ApplicationData_Open(userSid, m_packageFamilyName.c_str(), &applicationDataState));
return applicationDataState;
}
}
3 changes: 3 additions & 0 deletions dev/ApplicationData/M.W.S.ApplicationData.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

#include "Microsoft.Windows.Storage.ApplicationData.g.h"

#include <FrameworkUdk/ApplicationData.h>

namespace winrt::Microsoft::Windows::Storage::implementation
{
struct ApplicationData : ApplicationDataT<ApplicationData>
Expand Down Expand Up @@ -42,6 +44,7 @@ namespace winrt::Microsoft::Windows::Storage::implementation
static hstring StorageFolderToPath(winrt::Windows::Storage::StorageFolder storageFolder);
static void _VerifyPublisher(winrt::hstring const& string);
static void _VerifyProduct(winrt::hstring const& string);
::ApplicationDataState OpenApplicationData();

private:
winrt::Windows::Storage::ApplicationData m_applicationData;
Expand Down
15 changes: 15 additions & 0 deletions dev/Common/Security.User.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,21 @@ inline PWSTR SidToString(PSID sid)
THROW_IF_WIN32_BOOL_FALSE(::ConvertSidToStringSidW(sid, &sidString));
return sidString;
}

/// @return a new sid. Allocated via LocalAlloc; use LocalFree to deallocate
inline wil::unique_any_psid CopySid(PSID source)
{
if (!source)
{
return null;
}

const auto size{ ::GetLengthSid(source) };
wil::unique_any_psid copy{ static_cast<PSID>(::LocalAlloc(LMEM_FIXED, size))};
THROW_IF_NULL_ALLOC(copy);
THROW_IF_WIN32_BOOL_FALSE(::CopySid(size, copy.get(), source));
return copy;
}
}

#endif // __SECURITY_USER_H
1 change: 1 addition & 0 deletions test/ApplicationData/ApplicationDataTests.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@
</Reference>
</ItemGroup>
<Target Name="CopyFiles" AfterTargets="AfterBuild">
<Copy SkipUnchangedFiles="true" SourceFiles="$(OutDir)\..\WindowsAppRuntime_DLL\Microsoft.Internal.FrameworkUdk.dll" DestinationFolder="$(OutDir)" />
<Copy SkipUnchangedFiles="true" SourceFiles="Test.testdef" DestinationFolder="$(OutDir)" />
</Target>
<ItemGroup>
Expand Down
Loading
Loading