将现有 pdf 与从头开始创建的 pdf 连接时如何保留页面标签?

How to retain page labels when concatenating an existing pdf with a pdf created from scratch?

我有一个代码正在创建 "cover page",然后将其与现有的 pdf 合并。合并后 pdf 标签丢失。如何保留现有 pdf 的 pdf 标签,然后将页面标签添加到从头开始创建的 pdf 页面(例如 "Cover page")?我认为这本书的例子是关于检索和替换页面标签的。在将现有 pdf 与从头开始创建的 pdf 连接时,我不知道如何应用它。我正在使用 itext 5.3.0。提前致谢。

编辑 根据 mkl

的评论
public ByteArrayOutputStream getConcatenatePDF()
{
    if (bitstream == null)
        return null;

    if (item == null)
    {
        item = getItem();
        if (item == null)
            return null;
    }

    ByteArrayOutputStream byteout = null;
    InputStream coverStream = null;

    try
    {
        // Get Cover Page
        coverStream = getCoverStream();
        if (coverStream == null) 
            return null;

        byteout = new ByteArrayOutputStream();
        int pageOffset = 0;
        ArrayList<HashMap<String, Object>> master = new ArrayList<HashMap<String, Object>>();

        Document document = null;
        PdfCopy    writer = null;
        PdfReader  reader = null;

        byte[] password = (ownerpass != null && !"".equals(ownerpass)) ? ownerpass.getBytes() : null;

        // Get infomation of the original pdf
        reader = new PdfReader(bitstream.retrieve(), password);

        boolean isPortfolio = reader.getCatalog().contains(PdfName.COLLECTION);
        char version = reader.getPdfVersion();
        int permissions = reader.getPermissions();

        // Get metadata
        HashMap<String, String> info = reader.getInfo();
        String title = (info.get("Title") == null || "".equals(info.get("Title")))
            ? getFieldValue("dc.title") : info.get("Title");
        String author = (info.get("Author") == null || "".equals(info.get("Author")))
            ? getFieldValue("dc.contributor.author") : info.get("Author");
        String subject = (info.get("Subject") == null || "".equals(info.get("Subject")))
            ? "" : info.get("Subject");
        String keywords = (info.get("Keywords") == null || "".equals(info.get("Keywords")))
            ? getFieldValue("dc.subject") : info.get("Keywords");

        reader.close();

        // Merge cover page and the original pdf
        InputStream[] is = new InputStream[2];
        is[0] = coverStream;
        is[1] = bitstream.retrieve();

        for (int i = 0; i < is.length; i++) 
        {
            // we create a reader for a certain document
            reader = new PdfReader(is[i], password);
            reader.consolidateNamedDestinations();

            if (i == 0) 
            {
                // step 1: creation of a document-object
                document = new Document(reader.getPageSizeWithRotation(1));

                // step 2: we create a writer that listens to the document
                writer = new PdfCopy(document, byteout);

                // Set metadata from the original pdf 
                // the position of these lines is important
                document.addTitle(title);
                document.addAuthor(author);
                document.addSubject(subject);
                document.addKeywords(keywords);

                if (pdfa)
                {
                    // Set thenecessary information for PDF/A-1B
                    // the position of these lines is important
                    writer.setPdfVersion(PdfWriter.VERSION_1_4);
                    writer.setPDFXConformance(PdfWriter.PDFA1B);
                    writer.createXmpMetadata();
                }
                else if (version == '5')
                    writer.setPdfVersion(PdfWriter.VERSION_1_5);
                else if (version == '6')
                    writer.setPdfVersion(PdfWriter.VERSION_1_6);
                else if (version == '7')
                    writer.setPdfVersion(PdfWriter.VERSION_1_7);
                else
                    ;  // no operation

                // Set security parameters
                if (!pdfa)
                {
                    if (password != null)
                    {
                        if (security && permissions != 0) 
                        {
                            writer.setEncryption(null, password, permissions, PdfWriter.STANDARD_ENCRYPTION_128);
                        } 
                        else
                        {
                            writer.setEncryption(null, password, PdfWriter.ALLOW_PRINTING | PdfWriter.ALLOW_COPY | PdfWriter.ALLOW_SCREENREADERS, PdfWriter.STANDARD_ENCRYPTION_128);
                        }
                    }
                }

                // step 3: we open the document
                document.open();

                // if this pdf is portfolio, does not add cover page
                if (isPortfolio)
                {
                    reader.close();
                    byte[] coverByte = getCoverByte();
                    if (coverByte == null || coverByte.length == 0) 
                        return null;
                    PdfCollection collection = new PdfCollection(PdfCollection.TILE);
                    writer.setCollection(collection);

                    PdfFileSpecification fs = PdfFileSpecification.fileEmbedded(writer, null, "cover.pdf", coverByte);
                    fs.addDescription("cover.pdf", false);
                    writer.addFileAttachment(fs);
                    continue;
                }
            }
            int n = reader.getNumberOfPages();
            // step 4: we add content
            PdfImportedPage page;
            PdfCopy.PageStamp stamp;
            for (int j = 0; j < n; )
            {
                ++j;
                page = writer.getImportedPage(reader, j);
                if (i == 1) {
                    stamp = writer.createPageStamp(page);
                    Rectangle mediabox = reader.getPageSize(j);
                    Rectangle crop = new Rectangle(mediabox);
                    writer.setCropBoxSize(crop);
                    // add overlay text
                    //<-- Code for adding overlay text -->
                    stamp.alterContents();
                }
                writer.addPage(page);
            }

            PRAcroForm form = reader.getAcroForm();
            if (form != null && !pdfa)
            {
                writer.copyAcroForm(reader);
            }
            // we retrieve the total number of pages
            List<HashMap<String, Object>> bookmarks = SimpleBookmark.getBookmark(reader);
            //if (bookmarks != null && !pdfa) 
            if (bookmarks != null) 
            {
                if (pageOffset != 0)
                {
                    SimpleBookmark.shiftPageNumbers(bookmarks, pageOffset, null);
                }
                master.addAll(bookmarks);
            }
            pageOffset += n;
        }
        if (!master.isEmpty())
        {
            writer.setOutlines(master);
        }

        if (isPortfolio)
        {
            reader = new PdfReader(bitstream.retrieve(), password);
            PdfDictionary catalog = reader.getCatalog();
            PdfDictionary documentnames = catalog.getAsDict(PdfName.NAMES);
            PdfDictionary embeddedfiles = documentnames.getAsDict(PdfName.EMBEDDEDFILES);
            PdfArray filespecs = embeddedfiles.getAsArray(PdfName.NAMES);
            PdfDictionary filespec;
            PdfDictionary refs;
            PRStream stream;
            PdfFileSpecification fs;
            String path;
            // copy embedded files
            for (int i = 0; i < filespecs.size(); ) 
            {
                filespecs.getAsString(i++);     // remove description
                filespec = filespecs.getAsDict(i++);
                refs = filespec.getAsDict(PdfName.EF);
                for (PdfName key : refs.getKeys()) 
                {
                    stream = (PRStream) PdfReader.getPdfObject(refs.getAsIndirectObject(key));
                    path = filespec.getAsString(key).toString();
                    fs = PdfFileSpecification.fileEmbedded(writer, null, path, PdfReader.getStreamBytes(stream));
                    fs.addDescription(path, false);
                    writer.addFileAttachment(fs);
                }
            }
        }

        if (pdfa)
        {
            InputStream iccFile = this.getClass().getClassLoader().getResourceAsStream(PROFILE);
            ICC_Profile icc = ICC_Profile.getInstance(iccFile);
            writer.setOutputIntents("Custom", "", "http://www.color.org", "sRGB IEC61966-2.1", icc);
            writer.setViewerPreferences(PdfWriter.PageModeUseOutlines);
        }
        // step 5: we close the document
        document.close();
    } 
    catch (Exception e) 
    {
        log.info(LogManager.getHeader(context, "cover_page: getConcatenatePDF", "bitstream_id="+bitstream.getID()+", error="+e.getMessage()));
        // e.printStackTrace();
        return null;
    }

    return byteout;
}

更新

根据mkl的回答,我修改了上面的代码如下:

    public ByteArrayOutputStream getConcatenatePDF()
{
    if (bitstream == null)
        return null;

    if (item == null)
    {
        item = getItem();
        if (item == null)
            return null;
    }

    ByteArrayOutputStream byteout = null;
    try
    {
        // Get Cover Page
        InputStream coverStream = getCoverStream();
        if (coverStream == null) 
            return null;

        byteout = new ByteArrayOutputStream();

        InputStream documentStream = bitstream.retrieve();


        PdfReader coverPageReader = new PdfReader(coverStream);
        PdfReader reader = new PdfReader(documentStream);
        PdfStamper stamper = new PdfStamper(reader, byteout);

        PdfImportedPage page = stamper.getImportedPage(coverPageReader, 1);
        stamper.insertPage(1, coverPageReader.getPageSize(1));

        PdfContentByte content = stamper.getUnderContent(1);

        int n = reader.getNumberOfPages();
        for (int j = 2; j <= n; j++) {
           //code for overlay text
            ColumnText.showTextAligned(stamper.getOverContent(j), Element.ALIGN_CENTER, overlayText,
                    crop.getLeft(10), crop.getHeight() / 2 + crop.getBottom(), 90);
        }
        content.addTemplate(page, 0, 0);
        stamper.close();
    }
    catch (Exception e) 
    {
        log.info(LogManager.getHeader(context, "cover_page: getConcatenatePDF", "bitstream_id="+bitstream.getID()+", error="+e.getMessage()));
        e.printStackTrace();
        return null;
    }

    return byteout;
}

然后我将页面标签设置为封面。我省略了与我的问题无关的代码。

/**
 * 
 * @return InputStream the resulting output stream
 */
private InputStream getCoverStream()
{
    ByteArrayOutputStream byteout = getCover();
    return new ByteArrayInputStream(byteout.toByteArray());
}

/**
 * 
 * @return InputStream the resulting output stream
 */
private byte[] getCoverByte()
{
    ByteArrayOutputStream byteout = getCover();
    return byteout.toByteArray();
}

/**
 * 
 * @return InputStream the resulting output stream
 */
    private ByteArrayOutputStream getCover()


{
    ByteArrayOutputStream byteout;
    Document doc = null;
    try 
    {
        byteout = new ByteArrayOutputStream();   
        doc = new Document(PageSize.LETTER, 24, 24, 20, 40);
        PdfWriter pdfwriter = PdfWriter.getInstance(doc, byteout);
        PdfPageLabels labels = new PdfPageLabels();
        labels.addPageLabel(1, PdfPageLabels.EMPTY, "Cover page", 1);
        pdfwriter.setPageLabels(labels);

        pdfwriter.setPageEvent(new HeaderFooter());
        doc.open(); 
        //code omitted (contents of cover page)
        doc.close();
        return byteout; 
    } 
    catch (Exception e)
    {
        log.info(LogManager.getHeader(context, "cover_page", "bitstream_id="+bitstream.getID()+", error="+e.getMessage()));
        return null;
    }
}

修改后的代码保留了现有 pdf 的页面标签(参见屏幕截图 1)(documentStream),但生成的合并 pdf(屏幕截图 2 和 3) 由于插入了封面页而关闭了 1 页。正如 mkl 所建议的,我应该在封面上使用页面标签,但导入页面的 pdf 标签似乎丢失了。我现在关心的是如何将页面标签设置为最终文档状态,这也是 mkl 所建议的?我想我应该使用 PdfWriter 但我不知道将它放在修改后的代码中的什么位置。我假设 stamper.close() 部分之后是我文档的最终状态是否正确?再次感谢。

屏幕截图 1. 注意标记为 的实际第 1 页 封面

屏幕截图 2. 合并 pdf,在插入即时生成的 "cover page" 之后。即使在我使用 labels.addPageLabel(1, PdfPageLabels.EMPTY, "Cover page", 1) 设置插入页面的 pdf 标签后,页面标签 "Front cover" 现在也已分配给封面

屏幕截图 3. 请注意,页面标签 3 已分配给页面 2。

最终更新 感谢 @mkl 下面的截图是我应用最新更新的 mkl 答案后的结果。页面标签现在已正确分配给页面。此外,使用 PdfStamper 而不是 PdfCopy(在我的原始代码中使用)并没有破坏 PDF/A 现有 pdf 的合规性。

添加封面

通常使用 PdfCopy 合并 PDF 是正确的选择,它从复制的页面创建一个新文档,复制尽可能多的 page-level 信息尽可能不偏爱任何单个文档。

不过,您的情况有些特殊:您有一个文档,其结构和内容是您喜欢的,并且想通过添加一页(标题页)对其进行小的更改。始终所有信息包括document-level来自主文档的信息(例如元数据,嵌入文件,......)仍然应该是出现在结果中。

在这种情况下,使用 PdfStamper 更合适,您可以使用它来 "stamp" 更改现有 PDF。

您可能希望从 this:

开始
try (   InputStream documentStream = getClass().getResourceAsStream("template.pdf");
        InputStream titleStream = getClass().getResourceAsStream("title.pdf");
        OutputStream outputStream = new FileOutputStream(new File(RESULT_FOLDER, "test-with-title-page.pdf"))    )
{
    PdfReader titleReader = new PdfReader(titleStream);
    PdfReader reader = new PdfReader(documentStream);
    PdfStamper stamper = new PdfStamper(reader, outputStream);

    PdfImportedPage page = stamper.getImportedPage(titleReader, 1);
    stamper.insertPage(1, titleReader.getPageSize(1));
    PdfContentByte content = stamper.getUnderContent(1);
    content.addTemplate(page, 0, 0);

    stamper.close();
}

PS:关于评论中的问题:

In my code above, I should have an overlay text supposedly (before the stamp.alterContents() portion) but I omitted that part of code for testing purposes. Can you please give me an idea how to implement that?

您是说叠加水印之类的东西吗? PdfStamper 允许您访问每个可以绘制任何内容的页面的 "over content":

PdfContentByte overContent = stamper.getOverContent(pageNumber);

保留页面标签

My other question is about page offset, because I inserted the cover page, the page numbering are off by 1 page. How can I resolve that?

不幸的是,iText 的 PdfStamper 不会 自动更新被操纵的 PDF 的页面标签定义。其实这也难怪,因为不清楚插入的页面是如何被标记的。 @Bruno 至少,iText 可以更改从 之后 插入页码开始的页面标签部分。

使用 iText 的低级别 API 但是,可以修复原始标签位置并为插入的页面添加标签。这可以类似于 iText in Action PageLabelExample 示例,更准确地说是它的 manipulatePageLabel 部分;只需在 stamper.close():

之前添加 this
    PdfDictionary root = reader.getCatalog();
    PdfDictionary labels = root.getAsDict(PdfName.PAGELABELS);
    if (labels != null)
    {
        PdfArray newNums = new PdfArray();

        newNums.add(new PdfNumber(0));
        PdfDictionary coverDict = new PdfDictionary();
        coverDict.put(PdfName.P, new PdfString("Cover Page"));
        newNums.add(coverDict);

        PdfArray nums = labels.getAsArray(PdfName.NUMS);
        if (nums != null)
        {
            for (int i = 0; i < nums.size() - 1; )
            {
                int n = nums.getAsNumber(i++).intValue();
                newNums.add(new PdfNumber(n+1));
                newNums.add(nums.getPdfObject(i++));
            }
        }

        labels.put(PdfName.NUMS, newNums);
        stamper.markUsed(labels);
    }

对于带有这些标签的文档:

它生成带有这些标签的文档:

保持 links

I just found out that the inserted page "Cover Page" lost its link annotations. I wonder if there's a workaround for this, since according to the book, the interactive features of the inserted page are lost when using PdfStamper.

事实上,在生成 类 的 iText PDF 中,只有 Pdf*Copy* 保留了注释等交互功能。不幸的是,人们必须决定是否要

  • 创建一个真正新的 PDF (PdfWriter),除了可嵌入的内容外,没有来自其他 PDF 的信息;
  • 处理单个现有 PDF ('PdfStamper'),保留该 PDF 的所有信息,但除了可嵌入的内容之外,不包含其他 PDF 的信息;
  • 合并任意数量的现有 PDF (PdfCopy),其中保留所有这些 PDF 的大部分 page-level 信息,但不包含任何 document-level 信息。

在你的情况下,我认为新封面只有静态内容,没有动态功能,因此假设 PdfStamper 是最好的。如果你只需要处理 links,你可以考虑手动复制 links,例如使用这个辅助方法

/**
 * <p>
 * A primitive attempt at copying links from page <code>sourcePage</code>
 * of <code>PdfReader reader</code> to page <code>targetPage</code> of
 * <code>PdfStamper stamper</code>.
 * </p>
 * <p>
 * This method is meant only for the use case at hand, i.e. copying a link
 * to an external URI without expecting any advanced features.
 * </p>
 */
void copyLinks(PdfStamper stamper, int targetPage, PdfReader reader, int sourcePage)
{
    PdfDictionary sourcePageDict = reader.getPageNRelease(sourcePage);
    PdfArray annotations = sourcePageDict.getAsArray(PdfName.ANNOTS);
    if (annotations != null && annotations.size() > 0)
    {
        for (PdfObject annotationObject : annotations)
        {
            annotationObject = PdfReader.getPdfObject(annotationObject);
            if (!annotationObject.isDictionary())
                continue;
            PdfDictionary annotation = (PdfDictionary) annotationObject;
            if (!PdfName.LINK.equals(annotation.getAsName(PdfName.SUBTYPE)))
                continue;

            PdfArray rectArray = annotation.getAsArray(PdfName.RECT);
            if (rectArray == null || rectArray.size() < 4)
                continue;
            Rectangle rectangle = PdfReader.getNormalizedRectangle(rectArray);

            PdfName hightLight = annotation.getAsName(PdfName.H);
            if (hightLight == null)
                hightLight = PdfAnnotation.HIGHLIGHT_INVERT;

            PdfDictionary actionDict = annotation.getAsDict(PdfName.A);
            if (actionDict == null || !PdfName.URI.equals(actionDict.getAsName(PdfName.S)))
                continue;
            PdfString urlPdfString = actionDict.getAsString(PdfName.URI);
            if (urlPdfString == null)
                continue;
            PdfAction action = new PdfAction(urlPdfString.toString());

            PdfAnnotation link = PdfAnnotation.createLink(stamper.getWriter(), rectangle, hightLight, action);
            stamper.addAnnotation(link, targetPage);
        }
    }
}

插入原始页面后立即调用:

        PdfImportedPage page = stamper.getImportedPage(titleReader, 1);
        stamper.insertPage(1, titleReader.getPageSize(1));
        PdfContentByte content = stamper.getUnderContent(1);
        content.addTemplate(page, 0, 0);
        copyLinks(stamper, 1, titleReader, 1);

注意,这个方法真的简单。它只考虑带有 URI 操作的 link,并使用与原始页面相同的位置、目标和突出显示设置在目标页面上创建一个 link。如果原来的使用了更细化的特征(例如,如果它自带外观流,甚至只是使用边框样式属性)而你想保留这些特征,你必须改进方法,将这些特征的条目也复制到新注释。