PDF Export - filename as parameter?

abonhote · February 18, 2019, 3:28pm

Hi all

Is there a way to tell the PDF export how the final filename should look like? At the moment, depending on the page’s location, the filename is pretty cryptic

I know there’s “name=xyz” for XAR exports; I tried that and many other combinations, like “filename=…”, that didn’t work.

Cheers

André

vmassol · February 18, 2019, 3:35pm

I don’t think you can control this ATM for PDF export, here’s the code:

github.com

xwiki/xwiki-platform/blob/3c0f6acbeb2629d5b55e7e2edc9ffc2cac3d993f/xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/web/ExportAction.java#L408


    handleRevision(context);


    XWikiDocument doc = context.getDoc();
    context.getResponse().setContentType(exportType.getMimeType());


    // Compute the name of the export. Since it's gong to be saved on the user's file system it needs to be a valid
    // File name. Thus we use the "path" serializer but replace the "/" separator by "_" since we're not computing
    // a directory hierarchy but a file name
    EntityReferenceSerializer<String> serializer =
        Utils.getComponent(EntityReferenceSerializer.TYPE_STRING, "path");
    String filename = serializer.serialize(doc.getDocumentReference()).replaceAll("/", "_");
    // Make sure we don't go over 255 chars since several filesystems don't support filename longer than that!
    filename = StringUtils.abbreviateMiddle(filename, "__", 255);
    context.getResponse().addHeader(
        "Content-disposition",
        String.format("inline; filename=%s.%s", filename, exportType.getExtension()));
    exporter.export(doc, context.getResponse().getOutputStream(), exportType, context);


    return null;
}

As you can see it’s currently the reference name of the current page on which you started the export.

vmassol · February 18, 2019, 3:35pm

You could create an improvement request in jira if you want and a Pull Request would be awesome too

abonhote · February 20, 2019, 9:34am

Hi Vincent

Jira - Done: https://jira.xwiki.org/browse/XWIKI-16164

Not really into pulling currently, sorry

Cheers

André