mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-05-15 10:45:54 +00:00

# Description of Changes Previously, the dropdown menu in the pipeline configuration displayed all endpoints, including disabled ones, and allowed API calls to them. Changes: - Updated EndpointInterceptor to correctly parse request URIs and match them to corresponding endpoint names in settings.yml, ensuring disabled endpoints are blocked. - Added a new API endpoint in SettingsController to expose the endpointStatus map, allowing the frontend to check which endpoints are disabled. - Updated pipeline.js to use this new API and hide disabled endpoints from the dropdown menu. Tests: - Created a new Docker Compose setup using a custom settings.yml where all endpoints are disabled. - Implemented a test script to run this setup, send API requests to disabled endpoints, and verify they are correctly blocked. [Bug Fix Video](https://youtu.be/L1z3jZh8z8E) Closes #2881 --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] 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 <77850077+Frooodle@users.noreply.github.com>
58 lines
2.2 KiB
Java
58 lines
2.2 KiB
Java
package stirling.software.SPDF.controller.api;
|
|
|
|
import java.io.IOException;
|
|
import java.util.Map;
|
|
|
|
import org.springframework.http.HttpStatus;
|
|
import org.springframework.http.ResponseEntity;
|
|
import org.springframework.stereotype.Controller;
|
|
import org.springframework.web.bind.annotation.GetMapping;
|
|
import org.springframework.web.bind.annotation.PostMapping;
|
|
import org.springframework.web.bind.annotation.RequestBody;
|
|
import org.springframework.web.bind.annotation.RequestMapping;
|
|
|
|
import io.swagger.v3.oas.annotations.Hidden;
|
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
|
|
|
import stirling.software.SPDF.config.EndpointConfiguration;
|
|
import stirling.software.SPDF.config.InstallationPathConfig;
|
|
import stirling.software.SPDF.model.ApplicationProperties;
|
|
import stirling.software.SPDF.utils.GeneralUtils;
|
|
|
|
@Controller
|
|
@Tag(name = "Settings", description = "Settings APIs")
|
|
@RequestMapping("/api/v1/settings")
|
|
@Hidden
|
|
public class SettingsController {
|
|
|
|
private final ApplicationProperties applicationProperties;
|
|
private final EndpointConfiguration endpointConfiguration;
|
|
|
|
public SettingsController(
|
|
ApplicationProperties applicationProperties,
|
|
EndpointConfiguration endpointConfiguration) {
|
|
this.applicationProperties = applicationProperties;
|
|
this.endpointConfiguration = endpointConfiguration;
|
|
}
|
|
|
|
@PostMapping("/update-enable-analytics")
|
|
@Hidden
|
|
public ResponseEntity<String> updateApiKey(@RequestBody Boolean enabled) throws IOException {
|
|
if (applicationProperties.getSystem().getEnableAnalytics() != null) {
|
|
return ResponseEntity.status(HttpStatus.ALREADY_REPORTED)
|
|
.body(
|
|
"Setting has already been set, To adjust please edit "
|
|
+ InstallationPathConfig.getSettingsPath());
|
|
}
|
|
GeneralUtils.saveKeyToSettings("system.enableAnalytics", enabled);
|
|
applicationProperties.getSystem().setEnableAnalytics(enabled);
|
|
return ResponseEntity.ok("Updated");
|
|
}
|
|
|
|
@GetMapping("/get-endpoints-status")
|
|
@Hidden
|
|
public ResponseEntity<Map<String, Boolean>> getDisabledEndpoints() {
|
|
return ResponseEntity.ok(endpointConfiguration.getEndpointStatuses());
|
|
}
|
|
}
|