PowerToys/src/common/updating/updateState.cpp

#include "pch.h"
#include "updateState.h"

#include <common/utils/json.h>
#include <common/utils/timeutil.h>
#include <common/version/helper.h>
#include <common/version/version.h>
#include <common/SettingsAPI/settings_helpers.h>

namespace
{
    const wchar_t PERSISTENT_STATE_FILENAME[] = L"\\UpdateState.json";
    const wchar_t UPDATE_STATE_MUTEX[] = L"Local\\PowerToysRunnerUpdateStateMutex";
    const VersionHelper CURRENT_VERSION(VERSION_MAJOR, VERSION_MINOR, VERSION_REVISION);
}

UpdateState deserialize(const json::JsonObject& json)
{
    UpdateState result;

    result.state = static_cast<UpdateState::State>(json.GetNamedNumber(L"state", UpdateState::upToDate));
    result.releasePageUrl = json.GetNamedString(L"releasePageUrl", L"");
    result.githubUpdateLastCheckedDate = timeutil::from_string(json.GetNamedString(L"githubUpdateLastCheckedDate", L"invalid").c_str());
    result.downloadedInstallerFilename = json.GetNamedString(L"downloadedInstallerFilename", L"");
    return result;
}

json::JsonObject serialize(const UpdateState& state)
{
    json::JsonObject json;

    if (state.githubUpdateLastCheckedDate.has_value())
    {
        json.SetNamedValue(L"githubUpdateLastCheckedDate", json::value(timeutil::to_string(*state.githubUpdateLastCheckedDate)));
    }
    json.SetNamedValue(L"releasePageUrl", json::value(state.releasePageUrl));
    json.SetNamedValue(L"state", json::value(static_cast<double>(state.state)));
    json.SetNamedValue(L"downloadedInstallerFilename", json::value(state.downloadedInstallerFilename));

    json.SetNamedValue(L"updateStateFileVersion", json::value(CURRENT_VERSION.toWstring()));

    return json;
}

bool IsOldFileVersion(const std::wstring_view fileVersion)
{
    if (fileVersion == L"")
    {
        return true;
    }

    const auto parsedVer = VersionHelper::fromString(fileVersion);
    return !parsedVer.has_value() || *parsedVer != CURRENT_VERSION;
}

UpdateState UpdateState::read()
{
    const auto filename = PTSettingsHelper::get_root_save_folder_location() + PERSISTENT_STATE_FILENAME;
    std::optional<json::JsonObject> json;
    wil::unique_mutex_nothrow mutex{ CreateMutexW(nullptr, FALSE, UPDATE_STATE_MUTEX) };
    auto lock = mutex.acquire();
    json = json::from_file(filename);

    if (json.has_value() && !IsOldFileVersion(json->GetNamedString(L"updateStateFileVersion", L"").c_str()))
    {
        return deserialize(*json);
    }
    else
    {
        std::error_code _;
        fs::remove(filename, _);
        UpdateState new_state;
        json::to_file(filename, serialize(new_state));

        return new_state;
    }
}

void UpdateState::store(std::function<void(UpdateState&)> stateModifier)
{
    const auto filename = PTSettingsHelper::get_root_save_folder_location() + PERSISTENT_STATE_FILENAME;

    std::optional<json::JsonObject> json;
    {
        wil::unique_mutex_nothrow mutex{ CreateMutexW(nullptr, FALSE, UPDATE_STATE_MUTEX) };
        auto lock = mutex.acquire();
        json = json::from_file(filename);
        UpdateState state;
        if (json)
        {
            state = deserialize(*json);
        }
        stateModifier(state);
        json.emplace(serialize(state));
        json::to_file(filename, *json);
    }
}