Examples with XARInputProperties org.xwiki.filter.xar.input.XARInputProperties used on opensource projects

Example 1 with XARInputProperties

use of org.xwiki.filter.xar.input.XARInputProperties in project xwiki-platform by xwiki.

the class ImportAction method importPackageFilterStream.

private void importPackageFilterStream(XWikiAttachment packFile, XWikiRequest request, XWikiContext context) throws IOException, XWikiException, FilterException {
    String[] pages = request.getParameterValues("pages");
    XARInputProperties xarProperties = new XARInputProperties();
    DocumentInstanceOutputProperties instanceProperties = new DocumentInstanceOutputProperties();
    instanceProperties.setSaveComment("Imported from XAR");
    if (pages != null) {
        EntityReferenceSet entities = new EntityReferenceSet();
        EntityReferenceResolver<String> resolver = Utils.getComponent(EntityReferenceResolver.TYPE_STRING, "relative");
        for (String pageEntry : pages) {
            if (StringUtils.isNotEmpty(pageEntry)) {
                String locale = getLocale(pageEntry, request);
                int iAction = getAction(pageEntry, locale, request);
                String documentReference = getDocumentReference(pageEntry);
                if (iAction == DocumentInfo.ACTION_OVERWRITE) {
                    entities.includes(new LocalDocumentReference(resolver.resolve(documentReference, EntityType.DOCUMENT), LocaleUtils.toLocale(locale)));
                }
            }
        }
        xarProperties.setEntities(entities);
    }
    // Set the appropriate strategy to handle versions
    if (StringUtils.equals(request.getParameter("historyStrategy"), "reset")) {
        instanceProperties.setPreviousDeleted(true);
        instanceProperties.setVersionPreserved(false);
        xarProperties.setWithHistory(false);
    } else if (StringUtils.equals(request.getParameter("historyStrategy"), "replace")) {
        instanceProperties.setPreviousDeleted(true);
        instanceProperties.setVersionPreserved(true);
        xarProperties.setWithHistory(true);
    } else {
        instanceProperties.setPreviousDeleted(false);
        instanceProperties.setVersionPreserved(false);
        xarProperties.setWithHistory(false);
    }
    // Set the backup pack option
    if (StringUtils.equals(request.getParameter("importAsBackup"), "true")) {
        instanceProperties.setAuthorPreserved(true);
    } else {
        instanceProperties.setAuthorPreserved(false);
    }
    BeanInputFilterStreamFactory<XARInputProperties> xarFilterStreamFactory = Utils.getComponent((Type) InputFilterStreamFactory.class, FilterStreamType.XWIKI_XAR_CURRENT.serialize());
    BeanInputFilterStream<XARInputProperties> xarFilterStream = xarFilterStreamFactory.createInputFilterStream(xarProperties);
    BeanOutputFilterStreamFactory<InstanceOutputProperties> instanceFilterStreamFactory = Utils.getComponent((Type) OutputFilterStreamFactory.class, FilterStreamType.XWIKI_INSTANCE.serialize());
    BeanOutputFilterStream<InstanceOutputProperties> instanceFilterStream = instanceFilterStreamFactory.createOutputFilterStream(instanceProperties);
    // Notify all the listeners about import
    ObservationManager observation = Utils.getComponent(ObservationManager.class);
    InputStream source = packFile.getContentInputStream(context);
    xarProperties.setSource(new DefaultInputStreamInputSource(source));
    // Setup log
    xarProperties.setVerbose(true);
    instanceProperties.setVerbose(true);
    instanceProperties.setStoppedWhenSaveFail(false);
    LoggerManager loggerManager = Utils.getComponent(LoggerManager.class);
    LogQueue logger = new LogQueue();
    if (loggerManager != null) {
        // Isolate log
        loggerManager.pushLogListener(new LoggerListener(UUID.randomUUID().toString(), logger));
    }
    observation.notify(new XARImportingEvent(), null, context);
    try {
        xarFilterStream.read(instanceFilterStream.getFilter());
        xarFilterStream.close();
        instanceFilterStream.close();
    } finally {
        if (loggerManager != null) {
            // Stop isolating log
            loggerManager.popLogListener();
        }
        // Print the import log
        if (LOGGER.isDebugEnabled()) {
            logger.log(LOGGER);
        } else {
            // TODO: remove when the UI show the log properly
            for (LogEvent logEvent : logger.getLogsFrom(LogLevel.ERROR)) {
                logEvent.log(LOGGER);
            }
        }
        // Close the input source
        source.close();
        observation.notify(new XARImportedEvent(), null, context);
    }
    // Generate import report
    // Emulate old packager report (for retro compatibility)
    Package oldImporter = new Package();
    if (logger.containLogsFrom(LogLevel.ERROR)) {
        context.put("install_status", DocumentInfo.INSTALL_ERROR);
    } else {
        context.put("install_status", DocumentInfo.INSTALL_OK);
    }
    EntityReferenceSerializer<String> serializer = Utils.getComponent(EntityReferenceSerializer.TYPE_STRING, "local");
    for (LogEvent log : logger) {
        Marker marker = log.getMarker();
        if (marker != null) {
            if (marker.contains(WikiDocumentFilter.LOG_DOCUMENT_CREATED.getName()) || marker.contains(WikiDocumentFilter.LOG_DOCUMENT_UPDATED.getName())) {
                oldImporter.getInstalled(context).add(serializer.serialize((EntityReference) log.getArgumentArray()[0]));
            } else if (marker.contains(WikiDocumentFilter.LOG_DOCUMENT_SKIPPED.getName())) {
                oldImporter.getSkipped(context).add(serializer.serialize((EntityReference) log.getArgumentArray()[0]));
            } else if (marker.contains(WikiDocumentFilter.LOG_DOCUMENT_ERROR.getName())) {
                Object entity = log.getArgumentArray()[0];
                if (entity != null) {
                    oldImporter.getErrors(context).add(entity instanceof EntityReference ? serializer.serialize((EntityReference) log.getArgumentArray()[0]) : entity.toString());
                }
            }
        }
    }
}

Example 2 with XARInputProperties

use of org.xwiki.filter.xar.input.XARInputProperties in project xwiki-platform by xwiki.

the class Packager method getXWikiDocument.

public XWikiDocument getXWikiDocument(InputStream source, WikiReference wikiReference) throws FilterException, IOException, ComponentLookupException {
    // Output
    DocumentInstanceOutputProperties documentProperties = new DocumentInstanceOutputProperties();
    documentProperties.setDefaultReference(wikiReference);
    documentProperties.setVersionPreserved(false);
    // Input
    XARInputProperties xarProperties = new XARInputProperties();
    xarProperties.setWithHistory(false);
    return this.documentImporter.importDocument(new DefaultInputStreamInputSource(source), xarProperties, documentProperties);
}

Example 3 with XARInputProperties

use of org.xwiki.filter.xar.input.XARInputProperties in project xwiki-platform by xwiki.

the class XWikiDocument method fromXML.

public void fromXML(InputSource source, boolean withArchive) throws XWikiException {
    // Output
    DocumentInstanceOutputProperties documentProperties = new DocumentInstanceOutputProperties();
    XWikiContext xcontext = getXWikiContext();
    if (xcontext != null) {
        documentProperties.setDefaultReference(getXWikiContext().getWikiReference());
    }
    documentProperties.setVersionPreserved(withArchive);
    // Input
    XARInputProperties xarProperties = new XARInputProperties();
    xarProperties.setWithHistory(withArchive);
    try {
        Utils.getComponent(XWikiDocumentFilterUtils.class).importEntity(XWikiDocument.class, this, source, xarProperties, documentProperties);
    } catch (Exception e) {
        throw new XWikiException(XWikiException.MODULE_XWIKI_DOC, XWikiException.ERROR_DOC_XML_PARSING, "Error parsing xml", e, null);
    }
    // We have been reading from XML so the document does not need a new version when saved
    setMetaDataDirty(false);
    setContentDirty(false);
}

Example 4 with XARInputProperties

use of org.xwiki.filter.xar.input.XARInputProperties in project xwiki-platform by xwiki.

the class XWikiDocumentFilterUtils method importEntity.

/**
 * @param entityClass to class used to find the {@link EntityOutputFilterStream} component
 * @param entity the entity to write to or null to create a new entity of the passed class
 * @param source the stream to read
 * @param xarProperties the configuration of the input filter
 * @param documentProperties the configuration of the output filter
 * @return the imported entity, same as {@code entity} if not null
 * @throws FilterException when failing to import
 * @throws IOException when failing to import
 * @throws ComponentLookupException when failing to find a EntityOutputFilterStream corresponding to passed class
 */
public <T> T importEntity(Class<T> entityClass, T entity, InputSource source, XARInputProperties xarProperties, DocumentInstanceOutputProperties documentProperties) throws FilterException, IOException, ComponentLookupException {
    // Output
    EntityOutputFilterStream<T> filterStream = this.componentManager.getInstance(new DefaultParameterizedType(null, EntityOutputFilterStream.class, entityClass));
    filterStream.setProperties(documentProperties);
    filterStream.setEntity(entity);
    if (filterStream instanceof XWikiDocumentOutputFilterStream) {
        ((XWikiDocumentOutputFilterStream) filterStream).disableRenderingEvents();
    }
    // Input
    xarProperties.setSourceType(getSourceType(entityClass));
    xarProperties.setSource(source);
    BeanInputFilterStream<XARInputProperties> xarReader = ((BeanInputFilterStreamFactory<XARInputProperties>) this.xarInputFilterStreamFactory).createInputFilterStream(xarProperties);
    // Convert
    xarReader.read(filterStream.getFilter());
    xarReader.close();
    return filterStream.getEntity();
}

Example 5 with XARInputProperties

use of org.xwiki.filter.xar.input.XARInputProperties in project xwiki-platform by xwiki.

the class XWikiDocumentFilterUtils method importEntity.

/**
 * @param entity the entity to write to or its class to create a new one
 * @param source the stream to read
 * @return the imported entity, same as {@code entity} if not null
 * @throws FilterException when failing to import
 * @throws IOException when failing to import
 * @throws ComponentLookupException when failing to find a EntityOutputFilterStream corresponding to passed class
 */
public <T> T importEntity(Object entity, InputSource source) throws FilterException, IOException, ComponentLookupException {
    // Output
    DocumentInstanceOutputProperties documentProperties = new DocumentInstanceOutputProperties();
    // Input
    XARInputProperties xarProperties = new XARInputProperties();
    return importEntity(getClass(entity), entity instanceof Class ? null : (T) entity, source, xarProperties, documentProperties);
}