jalr/OpenRGB
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Gathering logging info to fix #1241

Browse source 
* Aligning profile version and header string
* Adding profile validation loggging
* Adding success / failure logging for each controller when attempting
to load profile
This commit is contained in:
Chris 2021-03-26 22:53:00 +11:00 • committed by Adam Honse
parent e3f7394498
commit ae8b502ad2
1 changed files with 26 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

49
ProfileManager.cpp
View file

@ -8,6 +8,9 @@
#include <iostream>
#include <cstring>
#define OPENRGB_PROFILE_HEADER "OPENRGB_PROFILE"
#define OPENRGB_PROFILE_VERSION 1
namespace fs = std::experimental::filesystem;
ProfileManager::ProfileManager(std::string config_dir)
@ -60,8 +63,8 @@ bool ProfileManager::SaveProfile(std::string profile_name, bool sizes)
| 16 bytes - "OPENRGB_PROFILE" |
| 4 bytes - Version, unsigned int |
\*---------------------------------------------------------*/
unsigned int profile_version = 1;
controller_file.write("OPENRGB_PROFILE", 16);
unsigned int profile_version = OPENRGB_PROFILE_VERSION;
controller_file.write(OPENRGB_PROFILE_HEADER, 16);
controller_file.write((char *)&profile_version, sizeof(unsigned int));
/*---------------------------------------------------------*\
@ -69,7 +72,7 @@ bool ProfileManager::SaveProfile(std::string profile_name, bool sizes)
\*---------------------------------------------------------*/
for(std::size_t controller_index = 0; controller_index < controllers.size(); controller_index++)
{
unsigned char *controller_data = controllers[controller_index]->GetDeviceDescription(0);
unsigned char *controller_data = controllers[controller_index]->GetDeviceDescription(profile_version);
unsigned int controller_size;
memcpy(&controller_size, controller_data, sizeof(controller_size));
@ -124,7 +127,6 @@ std::vector<RGBController*> ProfileManager::LoadProfileToList
unsigned int controller_offset = 0;
bool ret_val = false;
std::string filename = configuration_directory + profile_name;
/*---------------------------------------------------------*\
@ -147,18 +149,18 @@ std::vector<RGBController*> ProfileManager::LoadProfileToList
/*---------------------------------------------------------*\
| Read and verify file header |
\*---------------------------------------------------------*/
char header_string[16]{};
unsigned int header_version;
char profile_string[16];
unsigned int profile_version;
controller_file.read(header_string, 16);
controller_file.read((char *)&header_version, sizeof(unsigned int));
controller_file.read(profile_string, 16);
controller_file.read((char *)&profile_version, sizeof(unsigned int));
controller_offset += 16 + sizeof(unsigned int);
controller_file.seekg(controller_offset);
if(strcmp(header_string, "OPENRGB_PROFILE") == 0)
if(strcmp(profile_string, OPENRGB_PROFILE_HEADER) == 0)
{
if(header_version == 1)
if(profile_version <= OPENRGB_PROFILE_VERSION)
{
/*---------------------------------------------------------*\
| Read controller data from file until EOF |
@ -175,7 +177,7 @@ std::vector<RGBController*> ProfileManager::LoadProfileToList
RGBController_Dummy *temp_controller = new RGBController_Dummy();
temp_controller->ReadDeviceDescription(controller_data, 0);
temp_controller->ReadDeviceDescription(controller_data, profile_version);
temp_controllers.push_back(temp_controller);
@ -347,10 +349,9 @@ bool ProfileManager::LoadProfileWithOptions
\*---------------------------------------------------------*/
for(std::size_t controller_index = 0; controller_index < controllers.size(); controller_index++)
{
if(LoadDeviceFromListWithOptions(temp_controllers, temp_controller_used, controllers[controller_index], load_size, load_settings))
{
ret_val = true;
}
ret_val = LoadDeviceFromListWithOptions(temp_controllers, temp_controller_used, controllers[controller_index], load_size, load_settings);
std::string current_name = controllers[controller_index]->name + " @ " + controllers[controller_index]->location;
LOG_NOTICE("Profile loading: %s for %s", ( ret_val ? "Succeeded" : "FAILED!" ), current_name.c_str());
}
/*---------------------------------------------------------*\
@ -382,10 +383,10 @@ void ProfileManager::UpdateProfileList()
{
std::string filename = entry.path().filename().string();
LOG_NOTICE("Loading profile: %s", filename.c_str());
if(filename.find(".orp") != std::string::npos)
{
LOG_NOTICE("Found file: %s attempting to validate header", filename.c_str());
/*---------------------------------------------------------*\
| Open input file in binary mode |
\*---------------------------------------------------------*/
@ -394,21 +395,23 @@ void ProfileManager::UpdateProfileList()
/*---------------------------------------------------------*\
| Read and verify file header |
\*---------------------------------------------------------*/
char header_string[16];
unsigned int header_version;
char profile_string[16];
unsigned int profile_version;
profile_file.read(header_string, 16);
profile_file.read((char *)&header_version, sizeof(unsigned int));
profile_file.read(profile_string, 16);
profile_file.read((char *)&profile_version, sizeof(unsigned int));
if(strcmp(header_string, "OPENRGB_PROFILE") == 0)
if(strcmp(profile_string, OPENRGB_PROFILE_HEADER) == 0)
{
if(header_version == 1)
if(profile_version <= OPENRGB_PROFILE_VERSION)
{
/*---------------------------------------------------------*\
| Add this profile to the list |
\*---------------------------------------------------------*/
filename.erase(filename.length() - 4);
profile_list.push_back(filename);
LOG_NOTICE("Valid v%i profile found for %s", profile_version, filename.c_str());
}
}