Skip to content
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.

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

Add installed files and startup link metadata collection in Installer Metadata collection util #2985

Merged
merged 15 commits into from Mar 14, 2023

Conversation

yao-msft
Copy link
Contributor

@yao-msft yao-msft commented Feb 18, 2023

Tested manually and added unit tests for merging related logic.

Microsoft Reviewers: Open in CodeFlow

@yao-msft yao-msft marked this pull request as ready for review March 2, 2023 01:37
@yao-msft yao-msft requested a review from a team as a code owner March 2, 2023 01:37
constexpr std::string_view s_ShellLinkFileExtension = ".lnk"sv;
const std::vector<std::pair<std::filesystem::path, std::string>> s_CandidateInstallLocationRoots =
{
{ Filesystem::GetExpandedPath("%LOCALAPPDATA%"), "%LOCALAPPDATA%" },
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer using known folders APIs over environment variables, but this will probably do.

if (relativePath)
{
// TODO: Here we assume the install location is the top directory of relative path.
auto installLocation = baseFolder / *relativePath->begin();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think for any of the base locations it is not uncommon for there to be a structure like base\publisher\application.

I think the only way to be able to know the real location is to watch these base locations and then score new directories based on new file count, where links are pointing, etc.

Of course, there isn't a good way to distinguish between the publisher and publisher\application directories unless the publisher directory is new and contains no other directories/files itself.

{
// Try to match the candidate install location roots first.
std::string installLocationString = installLocation.string();
for (auto const& entry : s_CandidateInstallLocationRoots)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a function to do this: ReplaceCommonPathPrefix in Filesystem.h. Could make it return a bool to indicate whether it replaced or not for your use here.


InstalledFilesCorrelation::InstalledFilesCorrelation()
{
m_fileWatchers.emplace_back(Filesystem::GetKnownFolderPath(FOLDERID_CommonStartMenu), std::string{ s_ShellLinkFileExtension });
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a convenience or are we truly required to have two watchers to watch two locations?

fileEntry.RelativeFilePath = relativePath->string();
std::ifstream in{ linkInfo->Path, std::ifstream::binary };
fileEntry.FileSha256 = Utility::SHA256::ComputeHash(in);
fileEntry.InvocationParameter = linkInfo->Args;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that we will want to simply invoke the shortcuts rather than directly running the executables, so I don't think that collecting this is necessary. But at the same time, it probably doesn't hurt.

@yao-msft yao-msft merged commit 0d181f6 into microsoft:master Mar 14, 2023
8 checks passed
@yao-msft yao-msft deleted the installationmetadata branch March 14, 2023 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants