Examples with DocumentInstanceInputProperties org.xwiki.filter.instance.input.DocumentInstanceInputProperties used on opensource projects

Example 1 with DocumentInstanceInputProperties

use of org.xwiki.filter.instance.input.DocumentInstanceInputProperties in project xwiki-platform by xwiki.

the class ExportAction method exportXAR.

private String exportXAR(XWikiContext context) throws XWikiException, IOException, FilterException {
    XWikiRequest request = context.getRequest();
    boolean history = Boolean.valueOf(request.get("history"));
    boolean backup = Boolean.valueOf(request.get("backup"));
    String author = request.get("author");
    String description = request.get("description");
    String licence = request.get("licence");
    String version = request.get("version");
    String name = request.get("name");
    String[] pages = request.getParameterValues("pages");
    boolean all = ArrayUtils.isEmpty(pages);
    if (!context.getWiki().getRightService().hasWikiAdminRights(context)) {
        context.put("message", "needadminrights");
        return "exception";
    }
    if (StringUtils.isEmpty(name)) {
        if (all) {
            name = "backup";
        } else {
            name = "export";
        }
    }
    if (context.getWiki().ParamAsLong("xwiki.action.export.xar.usefilter", 1) == 1) {
        // Create input wiki stream
        DocumentInstanceInputProperties inputProperties = new DocumentInstanceInputProperties();
        // We don't want to log the details
        inputProperties.setVerbose(false);
        inputProperties.setWithJRCSRevisions(history);
        inputProperties.setWithRevisions(false);
        EntityReferenceSet entities = new EntityReferenceSet();
        if (all) {
            entities.includes(new WikiReference(context.getWikiId()));
        } else {
            // Find all page references and add them for processing
            Collection<DocumentReference> pageList = resolvePagesToExport(pages, context);
            for (DocumentReference page : pageList) {
                entities.includes(page);
            }
        }
        inputProperties.setEntities(entities);
        InputFilterStreamFactory inputFilterStreamFactory = Utils.getComponent(InputFilterStreamFactory.class, FilterStreamType.XWIKI_INSTANCE.serialize());
        InputFilterStream inputFilterStream = inputFilterStreamFactory.createInputFilterStream(inputProperties);
        // Create output wiki stream
        XAROutputProperties xarProperties = new XAROutputProperties();
        // We don't want to log the details
        xarProperties.setVerbose(false);
        XWikiResponse response = context.getResponse();
        xarProperties.setTarget(new DefaultOutputStreamOutputTarget(response.getOutputStream()));
        xarProperties.setPackageName(name);
        if (description != null) {
            xarProperties.setPackageDescription(description);
        }
        if (licence != null) {
            xarProperties.setPackageLicense(licence);
        }
        if (author != null) {
            xarProperties.setPackageAuthor(author);
        }
        if (version != null) {
            xarProperties.setPackageVersion(version);
        }
        xarProperties.setPackageBackupPack(backup);
        xarProperties.setPreserveVersion(backup || history);
        BeanOutputFilterStreamFactory<XAROutputProperties> xarFilterStreamFactory = Utils.getComponent((Type) OutputFilterStreamFactory.class, FilterStreamType.XWIKI_XAR_CURRENT.serialize());
        OutputFilterStream outputFilterStream = xarFilterStreamFactory.createOutputFilterStream(xarProperties);
        // Export
        response.setContentType("application/zip");
        response.addHeader("Content-disposition", "attachment; filename=" + Util.encodeURI(name, context) + ".xar");
        inputFilterStream.read(outputFilterStream.getFilter());
        inputFilterStream.close();
        outputFilterStream.close();
        // Flush
        response.getOutputStream().flush();
        // Indicate that we are done with the response so no need to add anything
        context.setFinished(true);
    } else {
        PackageAPI export = ((PackageAPI) context.getWiki().getPluginApi("package", context));
        if (export == null) {
            // No Packaging plugin configured
            return "exception";
        }
        export.setWithVersions(history);
        if (author != null) {
            export.setAuthorName(author);
        }
        if (description != null) {
            export.setDescription(description);
        }
        if (licence != null) {
            export.setLicence(licence);
        }
        if (version != null) {
            export.setVersion(version);
        }
        export.setBackupPack(backup);
        export.setName(name);
        if (all) {
            export.backupWiki();
        } else {
            if (pages != null) {
                for (String pageName : pages) {
                    String defaultAction = request.get("action_" + pageName);
                    int iAction;
                    try {
                        iAction = Integer.parseInt(defaultAction);
                    } catch (Exception e) {
                        iAction = 0;
                    }
                    export.add(pageName, iAction);
                }
            }
            export.export();
        }
    }
    return null;
}

Example 2 with DocumentInstanceInputProperties

use of org.xwiki.filter.instance.input.DocumentInstanceInputProperties in project xwiki-platform by xwiki.

the class ExportActionTest method exportFullSpaceUsingWildcardsAsXAR.

@Test
public void exportFullSpaceUsingWildcardsAsXAR() throws Exception {
    ExportAction action = new ExportAction();
    XWikiContext context = oldcore.getXWikiContext();
    // Make it a XAR export
    XWikiRequest request = mock(XWikiRequest.class);
    when(request.get("format")).thenReturn("xar");
    context.setRequest(request);
    // Set other request parameters
    when(request.get("name")).thenReturn("myexport");
    // Export all pages in the "Space" space
    when(request.getParameterValues("pages")).thenReturn(new String[] { "Space.%" });
    // Make the current user have programming rights
    when(oldcore.getMockRightService().hasWikiAdminRights(context)).thenReturn(true);
    // Query Manager-related mocking
    QueryManager queryManager = oldcore.getMocker().registerMockComponent(QueryManager.class);
    Query query = mock(Query.class);
    when(queryManager.createQuery(anyString(), eq(Query.HQL))).thenReturn(query);
    when(query.setWiki("xwiki")).thenReturn(query);
    when(query.bindValues(any(List.class))).thenReturn(query);
    when(query.execute()).thenReturn(Arrays.asList("Space.Page1", "Space.Page2"));
    // Register some mock resolver to resolve passed page references
    when(oldcore.getMockRightService().hasAccessLevel("view", "XWiki.XWikiGuest", "xwiki:Space.Page1", context)).thenReturn(true);
    when(oldcore.getMockRightService().hasAccessLevel("view", "XWiki.XWikiGuest", "xwiki:Space.Page2", context)).thenReturn(true);
    DocumentReferenceResolver<String> resolver = oldcore.getMocker().registerMockComponent(DocumentReferenceResolver.TYPE_STRING, "current");
    when(resolver.resolve("xwiki:Space.Page1")).thenReturn(new DocumentReference("xwiki", "Space", "Page1"));
    when(resolver.resolve("xwiki:Space.Page2")).thenReturn(new DocumentReference("xwiki", "Space", "Page2"));
    // Register some mock filters so that the export does nothing.
    InputFilterStreamFactory inputFilterStreamFactory = oldcore.getMocker().registerMockComponent(InputFilterStreamFactory.class, FilterStreamType.XWIKI_INSTANCE.serialize());
    when(inputFilterStreamFactory.createInputFilterStream(anyMap())).thenReturn(mock(InputFilterStream.class));
    BeanOutputFilterStreamFactory beanOutputFilterStreamFactory = mock(BeanOutputFilterStreamFactory.class);
    oldcore.getMocker().registerComponent(OutputFilterStreamFactory.class, FilterStreamType.XWIKI_XAR_CURRENT.serialize(), beanOutputFilterStreamFactory);
    when(beanOutputFilterStreamFactory.createOutputFilterStream(any(XAROutputProperties.class))).thenReturn(mock(BeanOutputFilterStream.class));
    // Set response stream
    XWikiResponse response = mock(XWikiResponse.class);
    ServletOutputStream outputStream = mock(ServletOutputStream.class);
    when(response.getOutputStream()).thenReturn(outputStream);
    context.setResponse(response);
    String result = action.render(oldcore.getXWikiContext());
    // The tests are below this line!
    // Verify null is returned (this means the response has been returned)
    assertNull(result);
    // Verify that the parameters passed to the input stream factory are defining the correct pages
    ArgumentCaptor<DocumentInstanceInputProperties> properties = ArgumentCaptor.forClass(DocumentInstanceInputProperties.class);
    verify(inputFilterStreamFactory).createInputFilterStream(properties.capture());
    assertEquals(false, properties.getValue().isVerbose());
    assertEquals(false, properties.getValue().isWithJRCSRevisions());
    assertEquals(false, properties.getValue().isWithRevisions());
    assertEquals(true, properties.getValue().getEntities().matches(new DocumentReference("xwiki", "Space", "Page1")));
    assertEquals(true, properties.getValue().getEntities().matches(new DocumentReference("xwiki", "Space", "Page2")));
}

Example 3 with DocumentInstanceInputProperties

use of org.xwiki.filter.instance.input.DocumentInstanceInputProperties in project xwiki-platform by xwiki.

the class XWikiDocument method toXML.

/**
 * Serialize the document to an OutputStream.
 *
 * @param out the output where to write the XML
 * @param bWithObjects include XObjects
 * @param bWithRendering include the rendered content
 * @param bWithAttachmentContent include attachments content
 * @param bWithVersions include archived versions
 * @param format true if the XML should be formated
 * @param encoding the encoding to use to write the XML
 * @throws XWikiException when an errors occurs during wiki operations
 * @since 9.0RC1
 */
public void toXML(OutputTarget out, boolean bWithObjects, boolean bWithRendering, boolean bWithAttachmentContent, boolean bWithVersions, boolean format, String encoding) throws XWikiException {
    // Input
    DocumentInstanceInputProperties documentProperties = new DocumentInstanceInputProperties();
    documentProperties.setWithWikiObjects(bWithObjects);
    documentProperties.setWithWikiDocumentContentHTML(bWithRendering);
    documentProperties.setWithWikiAttachmentsContent(bWithAttachmentContent);
    documentProperties.setWithJRCSRevisions(bWithVersions);
    documentProperties.setWithRevisions(false);
    // Output
    XAROutputProperties xarProperties = new XAROutputProperties();
    xarProperties.setPreserveVersion(bWithVersions);
    xarProperties.setEncoding(encoding);
    xarProperties.setFormat(format);
    try {
        Utils.getComponent(XWikiDocumentFilterUtils.class).exportEntity(this, out, xarProperties, documentProperties);
    } catch (Exception e) {
        throw new XWikiException(XWikiException.MODULE_XWIKI_DOC, XWikiException.ERROR_DOC_XML_PARSING, "Error parsing xml", e, null);
    }
}

Example 4 with DocumentInstanceInputProperties

use of org.xwiki.filter.instance.input.DocumentInstanceInputProperties in project xwiki-platform by xwiki.

the class XWikiDocumentFilterUtils method exportEntity.

/**
 * @param entity the entity to read
 * @param target the target where to write the result
 * @param xarProperties the configuration of the output filter
 * @param documentProperties the configuration of the input filter
 * @throws ComponentLookupException failed to find an event generator for passed entity
 * @throws FilterException when failing to generate export the passed entity
 * @throws IOException when failing to close the stream
 */
public void exportEntity(Object entity, OutputTarget target, XAROutputProperties xarProperties, DocumentInstanceInputProperties documentProperties) throws ComponentLookupException, FilterException, IOException {
    // Input
    documentProperties.setVerbose(false);
    // Output
    xarProperties.setForceDocument(true);
    if (target != null) {
        xarProperties.setTarget(target);
    }
    xarProperties.setVerbose(false);
    BeanOutputFilterStream<XAROutputProperties> xarFilter = ((BeanOutputFilterStreamFactory<XAROutputProperties>) this.xarOutputFilterStreamFactory).createOutputFilterStream(xarProperties);
    XARFilter filter = (XARFilter) xarFilter.getFilter();
    BeanEntityEventGenerator<Object, DocumentInstanceInputProperties> generator = this.componentManager.getInstance(new DefaultParameterizedType(null, EntityEventGenerator.class, getClass(entity)));
    // Spaces and document events
    FilterEventParameters documentParameters = null;
    DocumentReference documentReference = null;
    if (entity instanceof XWikiDocument) {
        documentReference = ((XWikiDocument) entity).getDocumentReference();
        for (SpaceReference spaceReference : documentReference.getSpaceReferences()) {
            filter.beginWikiSpace(spaceReference.getName(), FilterEventParameters.EMPTY);
        }
        documentParameters = new FilterEventParameters();
        documentParameters.put(WikiDocumentFilter.PARAMETER_LOCALE, ((XWikiDocument) entity).getDefaultLocale());
        filter.beginWikiDocument(documentReference.getName(), documentParameters);
    }
    // Document Locale events
    generator.write(entity, xarFilter, documentProperties);
    // Document and spaces events
    if (documentParameters != null) {
        filter.endWikiDocument(documentReference.getName(), documentParameters);
        documentReference = ((XWikiDocument) entity).getDocumentReference();
        for (EntityReference reference = documentReference.getParent(); reference instanceof SpaceReference; reference = reference.getParent()) {
            filter.beginWikiSpace(reference.getName(), FilterEventParameters.EMPTY);
        }
    }
    xarFilter.close();
}

Example 5 with DocumentInstanceInputProperties

use of org.xwiki.filter.instance.input.DocumentInstanceInputProperties in project xwiki-platform by xwiki.

the class DocumentInstanceInputFilterStreamTest method testImportDocumentsPreserveVersion.

// Tests
@Test
public void testImportDocumentsPreserveVersion() throws FilterException, IOException {
    DocumentInstanceOutputProperties outputProperties = new DocumentInstanceOutputProperties();
    outputProperties.setVersionPreserved(true);
    outputProperties.setVerbose(false);
    DocumentInstanceInputProperties inputProperties = new DocumentInstanceInputProperties();
    inputProperties.setWithRevisions(false);
    inputProperties.setWithJRCSRevisions(false);
    inputProperties.setVerbose(false);
    assertXML("document1", outputProperties, inputProperties);
}