mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-05-21 17:32:01 +00:00

# Description of Changes - **What was changed** - Updated controller methods to use strongly‐typed primitives (`int`, `long`, `boolean`) instead of `String` for numeric and boolean parameters, eliminating calls to `Integer.parseInt`/`Long.parseLong` and improving null‐safety (`Boolean.TRUE.equals(...)`). - Enhanced all API request model classes with richer Swagger/OpenAPI annotations: added `requiredMode`, `defaultValue`, `allowableValues`, `format`, `pattern`, and tightened schema descriptions for all fields. - Refactored HTML form templates for “Remove Blank Pages” to include `min`, `max`, and `step` attributes on numeric inputs, matching the updated validation rules. - **Why the change was made** - **Type safety & robustness**: Shifting from `String` to native types prevents runtime parsing errors, simplifies controller logic, and makes default values explicit. - **Better API documentation & validation**: Enriching the Swagger annotations ensures generated docs accurately reflect required fields, default values, and permitted ranges, which improves client code generation and developer experience. - **Consistency across codebase**: Aligning all request models and controllers enforces a uniform coding style and reduces bugs. #3406 --- ## 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) - [ ] 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.
163 lines
6.8 KiB
Java
163 lines
6.8 KiB
Java
package stirling.software.SPDF.controller.api;
|
|
|
|
import java.io.ByteArrayOutputStream;
|
|
import java.io.IOException;
|
|
import java.nio.file.Files;
|
|
import java.nio.file.Path;
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
import java.util.zip.ZipEntry;
|
|
import java.util.zip.ZipOutputStream;
|
|
|
|
import org.apache.pdfbox.multipdf.LayerUtility;
|
|
import org.apache.pdfbox.pdmodel.PDDocument;
|
|
import org.apache.pdfbox.pdmodel.PDPage;
|
|
import org.apache.pdfbox.pdmodel.PDPageContentStream;
|
|
import org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode;
|
|
import org.apache.pdfbox.pdmodel.common.PDRectangle;
|
|
import org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject;
|
|
import org.apache.pdfbox.util.Matrix;
|
|
import org.springframework.http.MediaType;
|
|
import org.springframework.http.ResponseEntity;
|
|
import org.springframework.web.bind.annotation.ModelAttribute;
|
|
import org.springframework.web.bind.annotation.PostMapping;
|
|
import org.springframework.web.bind.annotation.RequestMapping;
|
|
import org.springframework.web.bind.annotation.RestController;
|
|
import org.springframework.web.multipart.MultipartFile;
|
|
|
|
import io.github.pixee.security.Filenames;
|
|
import io.swagger.v3.oas.annotations.Operation;
|
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
|
|
|
import lombok.RequiredArgsConstructor;
|
|
|
|
import stirling.software.SPDF.model.api.SplitPdfBySectionsRequest;
|
|
import stirling.software.SPDF.service.CustomPDFDocumentFactory;
|
|
import stirling.software.SPDF.utils.WebResponseUtils;
|
|
|
|
@RestController
|
|
@RequestMapping("/api/v1/general")
|
|
@Tag(name = "General", description = "General APIs")
|
|
@RequiredArgsConstructor
|
|
public class SplitPdfBySectionsController {
|
|
|
|
private final CustomPDFDocumentFactory pdfDocumentFactory;
|
|
|
|
@PostMapping(value = "/split-pdf-by-sections", consumes = "multipart/form-data")
|
|
@Operation(
|
|
summary = "Split PDF pages into smaller sections",
|
|
description =
|
|
"Split each page of a PDF into smaller sections based on the user's choice"
|
|
+ " (halves, thirds, quarters, etc.), both vertically and horizontally."
|
|
+ " Input:PDF Output:ZIP-PDF Type:SISO")
|
|
public ResponseEntity<byte[]> splitPdf(@ModelAttribute SplitPdfBySectionsRequest request)
|
|
throws Exception {
|
|
List<ByteArrayOutputStream> splitDocumentsBoas = new ArrayList<>();
|
|
|
|
MultipartFile file = request.getFileInput();
|
|
PDDocument sourceDocument = pdfDocumentFactory.load(file);
|
|
|
|
// Process the PDF based on split parameters
|
|
int horiz = request.getHorizontalDivisions() + 1;
|
|
int verti = request.getVerticalDivisions() + 1;
|
|
boolean merge = Boolean.TRUE.equals(request.getMerge());
|
|
List<PDDocument> splitDocuments = splitPdfPages(sourceDocument, verti, horiz);
|
|
|
|
String filename =
|
|
Filenames.toSimpleFileName(file.getOriginalFilename())
|
|
.replaceFirst("[.][^.]+$", "");
|
|
if (merge) {
|
|
MergeController mergeController = new MergeController(pdfDocumentFactory);
|
|
ByteArrayOutputStream baos = new ByteArrayOutputStream();
|
|
mergeController.mergeDocuments(splitDocuments).save(baos);
|
|
return WebResponseUtils.bytesToWebResponse(baos.toByteArray(), filename + "_split.pdf");
|
|
}
|
|
for (PDDocument doc : splitDocuments) {
|
|
ByteArrayOutputStream baos = new ByteArrayOutputStream();
|
|
doc.save(baos);
|
|
doc.close();
|
|
splitDocumentsBoas.add(baos);
|
|
}
|
|
|
|
sourceDocument.close();
|
|
|
|
Path zipFile = Files.createTempFile("split_documents", ".zip");
|
|
byte[] data;
|
|
|
|
try (ZipOutputStream zipOut = new ZipOutputStream(Files.newOutputStream(zipFile))) {
|
|
int pageNum = 1;
|
|
for (int i = 0; i < splitDocumentsBoas.size(); i++) {
|
|
ByteArrayOutputStream baos = splitDocumentsBoas.get(i);
|
|
int sectionNum = (i % (horiz * verti)) + 1;
|
|
String fileName = filename + "_" + pageNum + "_" + sectionNum + ".pdf";
|
|
byte[] pdf = baos.toByteArray();
|
|
ZipEntry pdfEntry = new ZipEntry(fileName);
|
|
zipOut.putNextEntry(pdfEntry);
|
|
zipOut.write(pdf);
|
|
zipOut.closeEntry();
|
|
|
|
if (sectionNum == horiz * verti) pageNum++;
|
|
}
|
|
|
|
zipOut.finish();
|
|
data = Files.readAllBytes(zipFile);
|
|
return WebResponseUtils.bytesToWebResponse(
|
|
data, filename + "_split.zip", MediaType.APPLICATION_OCTET_STREAM);
|
|
|
|
} finally {
|
|
Files.deleteIfExists(zipFile);
|
|
}
|
|
}
|
|
|
|
public List<PDDocument> splitPdfPages(
|
|
PDDocument document, int horizontalDivisions, int verticalDivisions)
|
|
throws IOException {
|
|
List<PDDocument> splitDocuments = new ArrayList<>();
|
|
|
|
for (PDPage originalPage : document.getPages()) {
|
|
PDRectangle originalMediaBox = originalPage.getMediaBox();
|
|
float width = originalMediaBox.getWidth();
|
|
float height = originalMediaBox.getHeight();
|
|
float subPageWidth = width / horizontalDivisions;
|
|
float subPageHeight = height / verticalDivisions;
|
|
|
|
LayerUtility layerUtility = new LayerUtility(document);
|
|
|
|
for (int i = 0; i < horizontalDivisions; i++) {
|
|
for (int j = 0; j < verticalDivisions; j++) {
|
|
PDDocument subDoc = new PDDocument();
|
|
PDPage subPage = new PDPage(new PDRectangle(subPageWidth, subPageHeight));
|
|
subDoc.addPage(subPage);
|
|
|
|
PDFormXObject form =
|
|
layerUtility.importPageAsForm(
|
|
document, document.getPages().indexOf(originalPage));
|
|
|
|
try (PDPageContentStream contentStream =
|
|
new PDPageContentStream(
|
|
subDoc, subPage, AppendMode.APPEND, true, true)) {
|
|
// Set clipping area and position
|
|
float translateX = -subPageWidth * i;
|
|
|
|
// float translateY = height - subPageHeight * (verticalDivisions - j);
|
|
float translateY = -subPageHeight * (verticalDivisions - 1 - j);
|
|
|
|
contentStream.saveGraphicsState();
|
|
contentStream.addRect(0, 0, subPageWidth, subPageHeight);
|
|
contentStream.clip();
|
|
contentStream.transform(new Matrix(1, 0, 0, 1, translateX, translateY));
|
|
|
|
// Draw the form
|
|
contentStream.drawForm(form);
|
|
contentStream.restoreGraphicsState();
|
|
}
|
|
|
|
splitDocuments.add(subDoc);
|
|
}
|
|
}
|
|
}
|
|
|
|
return splitDocuments;
|
|
}
|
|
}
|