mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-15 02:54:06 +02: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.
97 lines
3.1 KiB
Java
97 lines
3.1 KiB
Java
package stirling.software.SPDF.controller.web;
|
|
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
import java.nio.charset.StandardCharsets;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
import org.springframework.core.io.ClassPathResource;
|
|
import org.springframework.core.io.Resource;
|
|
import org.springframework.http.MediaType;
|
|
import org.springframework.stereotype.Controller;
|
|
import org.springframework.ui.Model;
|
|
import org.springframework.web.bind.annotation.GetMapping;
|
|
import org.springframework.web.bind.annotation.ResponseBody;
|
|
|
|
import com.fasterxml.jackson.core.type.TypeReference;
|
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
|
|
|
import io.swagger.v3.oas.annotations.Hidden;
|
|
|
|
import lombok.RequiredArgsConstructor;
|
|
import lombok.extern.slf4j.Slf4j;
|
|
|
|
import stirling.software.SPDF.model.ApplicationProperties;
|
|
import stirling.software.SPDF.model.Dependency;
|
|
|
|
@Controller
|
|
@Slf4j
|
|
@RequiredArgsConstructor
|
|
public class HomeWebController {
|
|
|
|
private final ApplicationProperties applicationProperties;
|
|
|
|
@GetMapping("/about")
|
|
@Hidden
|
|
public String gameForm(Model model) {
|
|
model.addAttribute("currentPage", "about");
|
|
return "about";
|
|
}
|
|
|
|
@GetMapping("/licenses")
|
|
@Hidden
|
|
public String licensesForm(Model model) {
|
|
model.addAttribute("currentPage", "licenses");
|
|
Resource resource = new ClassPathResource("static/3rdPartyLicenses.json");
|
|
try {
|
|
InputStream is = resource.getInputStream();
|
|
String json = new String(is.readAllBytes(), StandardCharsets.UTF_8);
|
|
ObjectMapper mapper = new ObjectMapper();
|
|
Map<String, List<Dependency>> data =
|
|
mapper.readValue(json, new TypeReference<Map<String, List<Dependency>>>() {});
|
|
model.addAttribute("dependencies", data.get("dependencies"));
|
|
} catch (IOException e) {
|
|
log.error("exception", e);
|
|
}
|
|
return "licenses";
|
|
}
|
|
|
|
@GetMapping("/releases")
|
|
public String getReleaseNotes(Model model) {
|
|
return "releases";
|
|
}
|
|
|
|
@GetMapping("/")
|
|
public String home(Model model) {
|
|
model.addAttribute("currentPage", "home");
|
|
String showSurvey = System.getenv("SHOW_SURVEY");
|
|
boolean showSurveyValue = showSurvey == null || "true".equalsIgnoreCase(showSurvey);
|
|
model.addAttribute("showSurveyFromDocker", showSurveyValue);
|
|
return "home";
|
|
}
|
|
|
|
@GetMapping("/home")
|
|
public String root(Model model) {
|
|
return "redirect:/";
|
|
}
|
|
|
|
@GetMapping("/home-legacy")
|
|
public String homeLegacy(Model model) {
|
|
model.addAttribute("currentPage", "home-legacy");
|
|
return "home-legacy";
|
|
}
|
|
|
|
@GetMapping(value = "/robots.txt", produces = MediaType.TEXT_PLAIN_VALUE)
|
|
@ResponseBody
|
|
@Hidden
|
|
public String getRobotsTxt() {
|
|
Boolean allowGoogle = applicationProperties.getSystem().getGooglevisibility();
|
|
if (Boolean.TRUE.equals(allowGoogle)) {
|
|
return "User-agent: Googlebot\nAllow: /\n\nUser-agent: *\nAllow: /";
|
|
} else {
|
|
return "User-agent: Googlebot\nDisallow: /\n\nUser-agent: *\nDisallow: /";
|
|
}
|
|
}
|
|
}
|