mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-14 18:44:05 +02:00
# Description of Changes **What was changed:** - **Configuration Updates:** Replaced all calls to `GeneralUtils.saveKeyToConfig` with the new `GeneralUtils.saveKeyToSettings` method across multiple classes (e.g., `LicenseKeyChecker`, `InitialSetup`, `SettingsController`, etc.). This update ensures consistent management of configuration settings. - **File Path and Exception Handling:** Updated file path handling in `SPDFApplication` by creating `Path` objects from string paths and logging these paths for clarity. Also refined exception handling by catching more specific exceptions (e.g., using `IOException` instead of a generic `Exception`). - **Analytics Flag and Rate Limiting:** Changed the analytics flag in the application properties from a `String` to a `Boolean`, and updated related logic in `AppConfig` and `PostHogService`. The rate-limiting property retrieval in `AppConfig` was also refined for clarity. - **YAML Configuration Management:** Replaced the previous manual, line-based YAML merging logic in `ConfigInitializer` with a new `YamlHelper` class. This helper leverages the SnakeYAML engine to load, update, and save YAML configurations more robustly while preserving comments and formatting. **Why the change was made:** - **Improved Maintainability:** Consolidating configuration update logic into a single utility method (`saveKeyToSettings`) reduces code duplication and simplifies future maintenance. - **Enhanced Robustness:** The new `YamlHelper` class ensures that configuration files are merged accurately and safely, minimizing risks of data loss or format corruption. - **Better Type Safety and Exception Handling:** Switching the analytics flag to a Boolean and refining exception handling improves code robustness and debugging efficiency. - **Clarity and Consistency:** Standardizing file path handling and logging practices enhances code readability across the project. **Challenges encountered:** - **YAML Merging Complexity:** Integrating the new `YamlHelper` required careful handling to preserve existing settings, comments, and formatting during merges. - **Type Conversion and Backward Compatibility:** Updating the analytics flag from a string to a Boolean required extensive testing to ensure backward compatibility and proper functionality. - **Exception Granularity:** Refactoring exception handling from a generic to a more specific approach involved a detailed review to cover all edge cases. Closes #<issue_number> --- ## Checklist - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [x] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details. --------- Co-authored-by: Anthony Stirling <[email protected]>
80 lines
3.3 KiB
Java
80 lines
3.3 KiB
Java
package stirling.software.SPDF.config;
|
|
|
|
import java.io.FileNotFoundException;
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
import java.net.URISyntaxException;
|
|
import java.net.URL;
|
|
import java.nio.file.Files;
|
|
import java.nio.file.Path;
|
|
import java.nio.file.Paths;
|
|
import java.nio.file.StandardCopyOption;
|
|
|
|
import lombok.extern.slf4j.Slf4j;
|
|
|
|
/**
|
|
* A naive, line-based approach to merging "settings.yml" with "settings.yml.template" while
|
|
* preserving exact whitespace, blank lines, and inline comments -- but we only rewrite the file if
|
|
* the merged content actually differs.
|
|
*/
|
|
@Slf4j
|
|
public class ConfigInitializer {
|
|
|
|
public void ensureConfigExists() throws IOException, URISyntaxException {
|
|
// 1) If settings file doesn't exist, create from template
|
|
Path destPath = Paths.get(InstallationPathConfig.getSettingsPath());
|
|
if (Files.notExists(destPath)) {
|
|
Files.createDirectories(destPath.getParent());
|
|
try (InputStream in =
|
|
getClass().getClassLoader().getResourceAsStream("settings.yml.template")) {
|
|
if (in == null) {
|
|
throw new FileNotFoundException(
|
|
"Resource file not found: settings.yml.template");
|
|
}
|
|
Files.copy(in, destPath);
|
|
}
|
|
log.info("Created settings file from template");
|
|
} else {
|
|
// 2) Merge existing file with the template
|
|
URL templateResource = getClass().getClassLoader().getResource("settings.yml.template");
|
|
if (templateResource == null) {
|
|
throw new IOException("Resource not found: settings.yml.template");
|
|
}
|
|
|
|
// Copy template to a temp location so we can read lines
|
|
Path tempTemplatePath = Files.createTempFile("settings.yml", ".template");
|
|
try (InputStream in = templateResource.openStream()) {
|
|
Files.copy(in, tempTemplatePath, StandardCopyOption.REPLACE_EXISTING);
|
|
}
|
|
|
|
// Copy setting.yaml to a temp location so we can read lines
|
|
Path settingTempPath = Files.createTempFile("settings", ".yaml");
|
|
try (InputStream in = Files.newInputStream(destPath)) {
|
|
Files.copy(in, settingTempPath, StandardCopyOption.REPLACE_EXISTING);
|
|
}
|
|
|
|
YamlHelper settingsTemplateFile = new YamlHelper(tempTemplatePath);
|
|
YamlHelper settingsFile = new YamlHelper(settingTempPath);
|
|
|
|
boolean changesMade =
|
|
settingsTemplateFile.updateValuesFromYaml(settingsFile, settingsTemplateFile);
|
|
if (changesMade) {
|
|
settingsTemplateFile.save(destPath);
|
|
log.info("Settings file updated based on template changes.");
|
|
} else {
|
|
log.info("No changes detected; settings file left as-is.");
|
|
}
|
|
|
|
Files.deleteIfExists(tempTemplatePath);
|
|
Files.deleteIfExists(settingTempPath);
|
|
}
|
|
|
|
// 3) Ensure custom settings file exists
|
|
Path customSettingsPath = Paths.get(InstallationPathConfig.getCustomSettingsPath());
|
|
if (Files.notExists(customSettingsPath)) {
|
|
Files.createFile(customSettingsPath);
|
|
log.info("Created custom_settings file: {}", customSettingsPath.toString());
|
|
}
|
|
}
|
|
}
|