mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-06-23 07:55:07 +00:00

# Description of Changes - **What was changed:** - Removed explicit constructor definitions annotated with `@Autowired` across services, controllers, filters, and schedulers. - Added Lombok’s `@RequiredArgsConstructor` to automatically generate required-args constructors and eliminate boilerplate. - Introduced other Lombok annotations (`@Data`, `@Getter`, `@Setter`, `@EqualsAndHashCode`, `@NoArgsConstructor`) on model and API classes to replace manual getters/setters and constructors. - Standardized string comparisons to use the constant-first form (e.g., `"value".equals(variable)`). - Cleaned up unused imports and organized OpenAPI configuration by extracting default title/description constants. - **Why the change was made:** - To reduce repetitive boilerplate code and improve maintainability. - To leverage Lombok for cleaner, more consistent dependency injection and data modeling. - To ensure a uniform coding style across the entire codebase. #3406 --- ## Checklist ### General - [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 ### Testing (if applicable) - [ ] 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.
102 lines
3.9 KiB
Java
102 lines
3.9 KiB
Java
package stirling.software.SPDF.config;
|
|
|
|
import java.io.IOException;
|
|
import java.util.Properties;
|
|
import java.util.UUID;
|
|
|
|
import org.springframework.core.Ordered;
|
|
import org.springframework.core.annotation.Order;
|
|
import org.springframework.core.io.ClassPathResource;
|
|
import org.springframework.core.io.Resource;
|
|
import org.springframework.stereotype.Component;
|
|
|
|
import io.micrometer.common.util.StringUtils;
|
|
|
|
import jakarta.annotation.PostConstruct;
|
|
|
|
import lombok.RequiredArgsConstructor;
|
|
import lombok.extern.slf4j.Slf4j;
|
|
|
|
import stirling.software.SPDF.model.ApplicationProperties;
|
|
import stirling.software.SPDF.utils.GeneralUtils;
|
|
|
|
@Component
|
|
@Slf4j
|
|
@Order(Ordered.HIGHEST_PRECEDENCE + 1)
|
|
@RequiredArgsConstructor
|
|
public class InitialSetup {
|
|
|
|
private final ApplicationProperties applicationProperties;
|
|
|
|
@PostConstruct
|
|
public void init() throws IOException {
|
|
initUUIDKey();
|
|
initSecretKey();
|
|
initEnableCSRFSecurity();
|
|
initLegalUrls();
|
|
initSetAppVersion();
|
|
}
|
|
|
|
public void initUUIDKey() throws IOException {
|
|
String uuid = applicationProperties.getAutomaticallyGenerated().getUUID();
|
|
if (!GeneralUtils.isValidUUID(uuid)) {
|
|
// Generating a random UUID as the secret key
|
|
uuid = UUID.randomUUID().toString();
|
|
GeneralUtils.saveKeyToSettings("AutomaticallyGenerated.UUID", uuid);
|
|
applicationProperties.getAutomaticallyGenerated().setUUID(uuid);
|
|
}
|
|
}
|
|
|
|
public void initSecretKey() throws IOException {
|
|
String secretKey = applicationProperties.getAutomaticallyGenerated().getKey();
|
|
if (!GeneralUtils.isValidUUID(secretKey)) {
|
|
// Generating a random UUID as the secret key
|
|
secretKey = UUID.randomUUID().toString();
|
|
GeneralUtils.saveKeyToSettings("AutomaticallyGenerated.key", secretKey);
|
|
applicationProperties.getAutomaticallyGenerated().setKey(secretKey);
|
|
}
|
|
}
|
|
|
|
public void initEnableCSRFSecurity() throws IOException {
|
|
if (GeneralUtils.isVersionHigher(
|
|
"0.36.0", applicationProperties.getAutomaticallyGenerated().getAppVersion())) {
|
|
Boolean csrf = applicationProperties.getSecurity().getCsrfDisabled();
|
|
if (!csrf) {
|
|
GeneralUtils.saveKeyToSettings("security.csrfDisabled", false);
|
|
GeneralUtils.saveKeyToSettings("system.enableAnalytics", true);
|
|
applicationProperties.getSecurity().setCsrfDisabled(false);
|
|
}
|
|
}
|
|
}
|
|
|
|
public void initLegalUrls() throws IOException {
|
|
// Initialize Terms and Conditions
|
|
String termsUrl = applicationProperties.getLegal().getTermsAndConditions();
|
|
if (StringUtils.isEmpty(termsUrl)) {
|
|
String defaultTermsUrl = "https://www.stirlingpdf.com/terms-and-conditions";
|
|
GeneralUtils.saveKeyToSettings("legal.termsAndConditions", defaultTermsUrl);
|
|
applicationProperties.getLegal().setTermsAndConditions(defaultTermsUrl);
|
|
}
|
|
// Initialize Privacy Policy
|
|
String privacyUrl = applicationProperties.getLegal().getPrivacyPolicy();
|
|
if (StringUtils.isEmpty(privacyUrl)) {
|
|
String defaultPrivacyUrl = "https://www.stirlingpdf.com/privacy-policy";
|
|
GeneralUtils.saveKeyToSettings("legal.privacyPolicy", defaultPrivacyUrl);
|
|
applicationProperties.getLegal().setPrivacyPolicy(defaultPrivacyUrl);
|
|
}
|
|
}
|
|
|
|
public void initSetAppVersion() throws IOException {
|
|
String appVersion = "0.0.0";
|
|
Resource resource = new ClassPathResource("version.properties");
|
|
Properties props = new Properties();
|
|
try {
|
|
props.load(resource.getInputStream());
|
|
appVersion = props.getProperty("version");
|
|
} catch (Exception e) {
|
|
}
|
|
GeneralUtils.saveKeyToSettings("AutomaticallyGenerated.appVersion", appVersion);
|
|
applicationProperties.getAutomaticallyGenerated().setAppVersion(appVersion);
|
|
}
|
|
}
|