-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto detect presence of external dependencies (LibreOffice etc) and d…
…isable/enable features dynamically (#2082) * Create ExternalAppDepConfig.java * Update EndpointConfiguration.java * Hardening suggestions for Stirling-PDF / ExternalAppDepConfig (#2083) Switch order of literals to prevent NullPointerException Co-authored-by: pixeebot[bot] <104101892+pixeebot[bot]@users.noreply.github.com> --------- Co-authored-by: pixeebot[bot] <104101892+pixeebot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
a10d06b
commit 89da2a5
Showing
2 changed files
with
180 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
146 changes: 146 additions & 0 deletions
146
src/main/java/stirling/software/SPDF/config/ExternalAppDepConfig.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| package stirling.software.SPDF.config; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.context.annotation.Configuration; | ||
|
|
||
| import jakarta.annotation.PostConstruct; | ||
| import lombok.extern.slf4j.Slf4j; | ||
|
|
||
| @Configuration | ||
| @Slf4j | ||
| public class ExternalAppDepConfig { | ||
| @Autowired private EndpointConfiguration endpointConfiguration; | ||
|
|
||
| private boolean isCommandAvailable(String command) { | ||
| try { | ||
| ProcessBuilder processBuilder = new ProcessBuilder(); | ||
| if (System.getProperty("os.name").toLowerCase().contains("windows")) { | ||
| processBuilder.command("where", command); | ||
| } else { | ||
| processBuilder.command("which", command); | ||
| } | ||
| Process process = processBuilder.start(); | ||
| int exitCode = process.waitFor(); | ||
| return exitCode == 0; | ||
| } catch (Exception e) { | ||
| log.debug("Error checking for command {}: {}", command, e.getMessage()); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| private final Map<String, List<String>> commandToGroupMapping = | ||
| new HashMap<>() { | ||
| { | ||
| put("gs", List.of("Ghostscript")); | ||
| put("soffice", List.of("LibreOffice")); | ||
| put("ocrmypdf", List.of("OCRmyPDF")); | ||
| put("weasyprint", List.of("Weasyprint")); | ||
| put("pdftohtml", List.of("Pdftohtml")); | ||
| } | ||
| }; | ||
|
|
||
| private List<String> getAffectedFeatures(String group) { | ||
| return endpointConfiguration.getEndpointsForGroup(group).stream() | ||
| .map(endpoint -> formatEndpointAsFeature(endpoint)) | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| private String formatEndpointAsFeature(String endpoint) { | ||
| // First replace common terms | ||
| String feature = endpoint.replace("-", " ").replace("pdf", "PDF").replace("img", "image"); | ||
|
|
||
| // Split into words and capitalize each word | ||
| return Arrays.stream(feature.split("\\s+")) | ||
| .map(word -> capitalizeWord(word)) | ||
| .collect(Collectors.joining(" ")); | ||
| } | ||
|
|
||
| private String capitalizeWord(String word) { | ||
| if (word.isEmpty()) { | ||
| return word; | ||
| } | ||
| if ("pdf".equalsIgnoreCase(word)) { | ||
| return "PDF"; | ||
| } | ||
| return word.substring(0, 1).toUpperCase() + word.substring(1).toLowerCase(); | ||
| } | ||
|
|
||
| private void checkDependencyAndDisableGroup(String command) { | ||
| boolean isAvailable = isCommandAvailable(command); | ||
| if (!isAvailable) { | ||
| List<String> affectedGroups = commandToGroupMapping.get(command); | ||
|
|
||
| if (affectedGroups != null) { | ||
| for (String group : affectedGroups) { | ||
| List<String> affectedFeatures = getAffectedFeatures(group); | ||
| endpointConfiguration.disableGroup(group); | ||
| log.warn( | ||
| "Missing dependency: {} - Disabling group: {} (Affected features: {})", | ||
| command, | ||
| group, | ||
| affectedFeatures != null && !affectedFeatures.isEmpty() | ||
| ? String.join(", ", affectedFeatures) | ||
| : "unknown"); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @PostConstruct | ||
| public void checkDependencies() { | ||
|
|
||
| // Check core dependencies | ||
| checkDependencyAndDisableGroup("gs"); | ||
| checkDependencyAndDisableGroup("soffice"); | ||
| checkDependencyAndDisableGroup("ocrmypdf"); | ||
| checkDependencyAndDisableGroup("weasyprint"); | ||
| checkDependencyAndDisableGroup("pdftohtml"); | ||
|
|
||
| // Special handling for Python/OpenCV dependencies | ||
| boolean pythonAvailable = isCommandAvailable("python3") || isCommandAvailable("python"); | ||
| if (!pythonAvailable) { | ||
| List<String> pythonFeatures = getAffectedFeatures("Python"); | ||
| List<String> openCVFeatures = getAffectedFeatures("OpenCV"); | ||
|
|
||
| endpointConfiguration.disableGroup("Python"); | ||
| endpointConfiguration.disableGroup("OpenCV"); | ||
| log.warn( | ||
| "Missing dependency: Python - Disabling Python features: {} and OpenCV features: {}", | ||
| String.join(", ", pythonFeatures), | ||
| String.join(", ", openCVFeatures)); | ||
| } else { | ||
| // If Python is available, check for OpenCV | ||
| try { | ||
| ProcessBuilder processBuilder = new ProcessBuilder(); | ||
| if (System.getProperty("os.name").toLowerCase().contains("windows")) { | ||
| processBuilder.command("python", "-c", "import cv2"); | ||
| } else { | ||
| processBuilder.command("python3", "-c", "import cv2"); | ||
| } | ||
| Process process = processBuilder.start(); | ||
| int exitCode = process.waitFor(); | ||
| if (exitCode != 0) { | ||
| List<String> openCVFeatures = getAffectedFeatures("OpenCV"); | ||
| endpointConfiguration.disableGroup("OpenCV"); | ||
| log.warn( | ||
| "OpenCV not available in Python - Disabling OpenCV features: {}", | ||
| String.join(", ", openCVFeatures)); | ||
| } | ||
| } catch (Exception e) { | ||
| List<String> openCVFeatures = getAffectedFeatures("OpenCV"); | ||
| endpointConfiguration.disableGroup("OpenCV"); | ||
| log.warn( | ||
| "Error checking OpenCV: {} - Disabling OpenCV features: {}", | ||
| e.getMessage(), | ||
| String.join(", ", openCVFeatures)); | ||
| } | ||
| } | ||
| endpointConfiguration.logDisabledEndpointsSummary(); | ||
| } | ||
| } |