# Description of Changes This pull request includes several changes primarily focused on improving configuration management, removing deprecated methods, and updating paths for external dependencies. The most important changes are summarized below: ### Configuration Management Improvements: * Added a new `RuntimePathConfig` class to manage dynamic paths for operations and pipeline configurations (`src/main/java/stirling/software/SPDF/config/RuntimePathConfig.java`). * Removed the `bookAndHtmlFormatsInstalled` bean and its associated logic from `AppConfig` and `EndpointConfiguration` (`src/main/java/stirling/software/SPDF/config/AppConfig.java`, `src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java`). [[1]](diffhunk://#diff-4d774ec79aa55750c0a4739bee971b68877078b73654e863fd40ee924347e143L130-L138) [[2]](diffhunk://#diff-750f31f6ecbd64b025567108a33775cad339e835a04360affff82a09410b697dL12-L35) [[3]](diffhunk://#diff-750f31f6ecbd64b025567108a33775cad339e835a04360affff82a09410b697dL275-L280) ### External Dependency Path Updates: * Updated paths for `weasyprint` and `unoconvert` in `ExternalAppDepConfig` to use values from `RuntimePathConfig` (`src/main/java/stirling/software/SPDF/config/ExternalAppDepConfig.java`). [[1]](diffhunk://#diff-c47af298c07c2622aa98b038b78822c56bdb002de71081e102d344794e7832a6R12-L33) [[2]](diffhunk://#diff-c47af298c07c2622aa98b038b78822c56bdb002de71081e102d344794e7832a6L104-R115) ### Minor Adjustments: * Corrected a typo from "Unoconv" to "Unoconvert" in `EndpointConfiguration` (`src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java`). --- ## Checklist ### General - [ ] 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) - [ ] I have performed a self-review of my own code - [ ] 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) - [ ] 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.
198 lines
6.5 KiB
Java
198 lines
6.5 KiB
Java
package stirling.software.SPDF.config;
|
|
|
|
import java.io.IOException;
|
|
import java.nio.file.Files;
|
|
import java.nio.file.Path;
|
|
import java.nio.file.Paths;
|
|
import java.util.List;
|
|
import java.util.Properties;
|
|
import java.util.function.Predicate;
|
|
|
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
|
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
|
import org.springframework.context.annotation.Bean;
|
|
import org.springframework.context.annotation.Configuration;
|
|
import org.springframework.context.annotation.Lazy;
|
|
import org.springframework.context.annotation.Scope;
|
|
import org.springframework.core.io.ClassPathResource;
|
|
import org.springframework.core.io.Resource;
|
|
import org.springframework.core.io.ResourceLoader;
|
|
import org.thymeleaf.spring6.SpringTemplateEngine;
|
|
|
|
import lombok.extern.slf4j.Slf4j;
|
|
|
|
import stirling.software.SPDF.model.ApplicationProperties;
|
|
|
|
@Configuration
|
|
@Lazy
|
|
@Slf4j
|
|
public class AppConfig {
|
|
|
|
private final ApplicationProperties applicationProperties;
|
|
|
|
public AppConfig(ApplicationProperties applicationProperties) {
|
|
this.applicationProperties = applicationProperties;
|
|
}
|
|
|
|
@Bean
|
|
@ConditionalOnProperty(
|
|
name = "system.customHTMLFiles",
|
|
havingValue = "true",
|
|
matchIfMissing = false)
|
|
public SpringTemplateEngine templateEngine(ResourceLoader resourceLoader) {
|
|
SpringTemplateEngine templateEngine = new SpringTemplateEngine();
|
|
templateEngine.addTemplateResolver(new FileFallbackTemplateResolver(resourceLoader));
|
|
return templateEngine;
|
|
}
|
|
|
|
@Bean(name = "loginEnabled")
|
|
public boolean loginEnabled() {
|
|
return applicationProperties.getSecurity().getEnableLogin();
|
|
}
|
|
|
|
@Bean(name = "appName")
|
|
public String appName() {
|
|
String homeTitle = applicationProperties.getUi().getAppName();
|
|
return (homeTitle != null) ? homeTitle : "Stirling PDF";
|
|
}
|
|
|
|
@Bean(name = "appVersion")
|
|
public String appVersion() {
|
|
Resource resource = new ClassPathResource("version.properties");
|
|
Properties props = new Properties();
|
|
try {
|
|
props.load(resource.getInputStream());
|
|
return props.getProperty("version");
|
|
} catch (IOException e) {
|
|
log.error("exception", e);
|
|
}
|
|
return "0.0.0";
|
|
}
|
|
|
|
@Bean(name = "homeText")
|
|
public String homeText() {
|
|
return (applicationProperties.getUi().getHomeDescription() != null)
|
|
? applicationProperties.getUi().getHomeDescription()
|
|
: "null";
|
|
}
|
|
|
|
@Bean(name = "languages")
|
|
public List<String> languages() {
|
|
return applicationProperties.getUi().getLanguages();
|
|
}
|
|
|
|
@Bean(name = "navBarText")
|
|
public String navBarText() {
|
|
String defaultNavBar =
|
|
applicationProperties.getUi().getAppNameNavbar() != null
|
|
? applicationProperties.getUi().getAppNameNavbar()
|
|
: applicationProperties.getUi().getAppName();
|
|
return (defaultNavBar != null) ? defaultNavBar : "Stirling PDF";
|
|
}
|
|
|
|
@Bean(name = "enableAlphaFunctionality")
|
|
public boolean enableAlphaFunctionality() {
|
|
return applicationProperties.getSystem().getEnableAlphaFunctionality() != null
|
|
? applicationProperties.getSystem().getEnableAlphaFunctionality()
|
|
: false;
|
|
}
|
|
|
|
@Bean(name = "rateLimit")
|
|
public boolean rateLimit() {
|
|
String appName = System.getProperty("rateLimit");
|
|
if (appName == null) appName = System.getenv("rateLimit");
|
|
return (appName != null) ? Boolean.valueOf(appName) : false;
|
|
}
|
|
|
|
@Bean(name = "RunningInDocker")
|
|
public boolean runningInDocker() {
|
|
return Files.exists(Paths.get("/.dockerenv"));
|
|
}
|
|
|
|
@Bean(name = "configDirMounted")
|
|
public boolean isRunningInDockerWithConfig() {
|
|
Path dockerEnv = Paths.get("/.dockerenv");
|
|
// default to true if not docker
|
|
if (!Files.exists(dockerEnv)) {
|
|
return true;
|
|
}
|
|
Path mountInfo = Paths.get("/proc/1/mountinfo");
|
|
// this should always exist, if not some unknown usecase
|
|
if (!Files.exists(mountInfo)) {
|
|
return true;
|
|
}
|
|
try {
|
|
return Files.lines(mountInfo).anyMatch(line -> line.contains(" /configs "));
|
|
} catch (IOException e) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
@ConditionalOnMissingClass("stirling.software.SPDF.config.security.SecurityConfiguration")
|
|
@Bean(name = "activSecurity")
|
|
public boolean missingActivSecurity() {
|
|
return false;
|
|
}
|
|
|
|
@Bean(name = "directoryFilter")
|
|
public Predicate<Path> processOnlyFiles() {
|
|
return path -> {
|
|
if (Files.isDirectory(path)) {
|
|
return !path.toString().contains("processing");
|
|
} else {
|
|
return true;
|
|
}
|
|
};
|
|
}
|
|
|
|
@Bean(name = "termsAndConditions")
|
|
public String termsAndConditions() {
|
|
return applicationProperties.getLegal().getTermsAndConditions();
|
|
}
|
|
|
|
@Bean(name = "privacyPolicy")
|
|
public String privacyPolicy() {
|
|
return applicationProperties.getLegal().getPrivacyPolicy();
|
|
}
|
|
|
|
@Bean(name = "cookiePolicy")
|
|
public String cookiePolicy() {
|
|
return applicationProperties.getLegal().getCookiePolicy();
|
|
}
|
|
|
|
@Bean(name = "impressum")
|
|
public String impressum() {
|
|
return applicationProperties.getLegal().getImpressum();
|
|
}
|
|
|
|
@Bean(name = "accessibilityStatement")
|
|
public String accessibilityStatement() {
|
|
return applicationProperties.getLegal().getAccessibilityStatement();
|
|
}
|
|
|
|
@Bean(name = "analyticsPrompt")
|
|
@Scope("request")
|
|
public boolean analyticsPrompt() {
|
|
return applicationProperties.getSystem().getEnableAnalytics() == null
|
|
|| "undefined".equals(applicationProperties.getSystem().getEnableAnalytics());
|
|
}
|
|
|
|
@Bean(name = "analyticsEnabled")
|
|
@Scope("request")
|
|
public boolean analyticsEnabled() {
|
|
if (applicationProperties.getEnterpriseEdition().isEnabled()) return true;
|
|
return applicationProperties.getSystem().getEnableAnalytics() != null
|
|
&& Boolean.parseBoolean(applicationProperties.getSystem().getEnableAnalytics());
|
|
}
|
|
|
|
@Bean(name = "StirlingPDFLabel")
|
|
public String stirlingPDFLabel() {
|
|
return "Stirling-PDF" + " v" + appVersion();
|
|
}
|
|
|
|
@Bean(name = "UUID")
|
|
public String uuid() {
|
|
return applicationProperties.getAutomaticallyGenerated().getUUID();
|
|
}
|
|
}
|