Skip to content

Commit

Permalink
Initialize DTD document model (see #106)
Browse files Browse the repository at this point in the history
  • Loading branch information
@angelozerr
angelozerr committed Nov 14, 2018
1 parent 71226a9 commit ce0240b
Show file tree
Hide file tree
Showing 16 changed files with 579 additions and 78 deletions.
8 changes: 7 additions & 1 deletion ...src/main/java/org/eclipse/lsp4xml/extensions/contentmodel/model/CMElementDeclaration.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,13 @@ public interface CMElementDeclaration {
*
* @return the declared element name with the given prefix.
*/
String getName(String prefix);
default String getName(String prefix) {
String name = getName();
if (prefix == null || prefix.isEmpty()) {
return name;
}
return prefix + ":" + name;
}

/**
* Returns the attributes of this declared element.
Expand Down
121 changes: 64 additions & 57 deletions .../src/main/java/org/eclipse/lsp4xml/extensions/contentmodel/model/ContentModelManager.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,64 +10,40 @@
*/
package org.eclipse.lsp4xml.extensions.contentmodel.model;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.xerces.impl.Constants;
import org.apache.xerces.impl.xs.XSLoaderImpl;
import org.apache.xerces.xs.XSModel;
import org.eclipse.lsp4xml.dom.Element;
import org.eclipse.lsp4xml.dom.NoNamespaceSchemaLocation;
import org.eclipse.lsp4xml.dom.SchemaLocation;
import org.eclipse.lsp4xml.dom.XMLDocument;
import org.eclipse.lsp4xml.extensions.contentmodel.settings.XMLFileAssociation;
import org.eclipse.lsp4xml.extensions.contentmodel.uriresolver.XMLCacheResolverExtension;
import org.eclipse.lsp4xml.extensions.contentmodel.uriresolver.XMLCatalogResolverExtension;
import org.eclipse.lsp4xml.extensions.contentmodel.uriresolver.XMLFileAssociationResolverExtension;
import org.eclipse.lsp4xml.extensions.contentmodel.xsd.XSDDocument;
import org.eclipse.lsp4xml.uriresolver.CacheResourceDownloadingException;
import org.eclipse.lsp4xml.uriresolver.URIResolverExtensionManager;
import org.eclipse.lsp4xml.utils.URIUtils;
import org.w3c.dom.DOMError;
import org.w3c.dom.DOMErrorHandler;

/**
* Content model manager used to load XML Schema, DTD.
*
*/
public class ContentModelManager {

// private static final ContentModelManager INSTANCE = new ContentModelManager();
//
// public static ContentModelManager getInstance() {
// return INSTANCE;
// }

private final XSLoaderImpl loader;

private final Map<String, CMDocument> cmDocumentCache;

private final URIResolverExtensionManager resolverManager;
private final List<ContentModelProvider> modelProviders;

private final XMLCacheResolverExtension cacheResolverExtension;
private final XMLCatalogResolverExtension catalogResolverExtension;
private final XMLFileAssociationResolverExtension fileAssociationResolver;
private final URIResolverExtensionManager resolverManager;

public ContentModelManager(URIResolverExtensionManager resolverManager) {
this.resolverManager = resolverManager;
modelProviders = new ArrayList<>();
cmDocumentCache = Collections.synchronizedMap(new HashMap<>());
loader = new XSLoaderImpl();
loader.setParameter("http://apache.org/xml/properties/internal/entity-resolver", resolverManager);
loader.setParameter(Constants.DOM_ERROR_HANDLER, new DOMErrorHandler() {

@Override
public boolean handleError(DOMError error) {
if (error.getRelatedException() instanceof CacheResourceDownloadingException) {
throw ((CacheResourceDownloadingException) error.getRelatedException());
}
return false;
}
});
fileAssociationResolver = new XMLFileAssociationResolverExtension();
resolverManager.registerResolver(fileAssociationResolver);
catalogResolverExtension = new XMLCatalogResolverExtension();
Expand Down Expand Up @@ -100,57 +76,80 @@ public CMDocument findCMDocument(Element element, String namespaceURI) {
}

public CMDocument findCMDocument(XMLDocument xmlDocument, String namespaceURI) {
String systemId = null;
SchemaLocation schemaLocation = xmlDocument.getSchemaLocation();
if (schemaLocation != null) {
systemId = schemaLocation.getLocationHint(namespaceURI);
} else {
NoNamespaceSchemaLocation noNamespaceSchemaLocation = xmlDocument.getNoNamespaceSchemaLocation();
if (noNamespaceSchemaLocation != null) {
if (namespaceURI != null) {
// xsi:noNamespaceSchemaLocation doesn't define namespaces
return null;
}
systemId = noNamespaceSchemaLocation.getLocation();
} else {
// TODO : implement with DTD
}
}
return findCMDocument(xmlDocument.getDocumentURI(), namespaceURI, systemId);
ContentModelProvider modelProvider = getModelProviderByStandardAssociation(xmlDocument);
String systemId = modelProvider != null ? modelProvider.getSystemId(xmlDocument, namespaceURI) : null;
return findCMDocument(xmlDocument.getDocumentURI(), namespaceURI, systemId, modelProvider);
}

/**
* Returns the content model document loaded by the given uri and null
* otherwise.
*
* @param publicId the public identifier.
* @param systemId the expanded system identifier.
* @param publicId the public identifier.
* @param systemId the expanded system identifier.
* @param modelProvider
* @return the content model document loaded by the given uri and null
* otherwise.
*/
private CMDocument findCMDocument(String uri, String publicId, String systemId) {
private CMDocument findCMDocument(String uri, String publicId, String systemId,
ContentModelProvider modelProvider) {
// Resolve the XML Schema/DTD uri (file, http, etc)
String key = resolverManager.resolve(uri, publicId, systemId);
if (key == null) {
return null;
}
// the XML Schema, DTD can be resolved
if (modelProvider == null) {
// the model provider cannot be get with standard mean (xsi:schemaLocation,
// xsi:noNamespaceSchemaLocation, doctype)
// try to get it by using extension (ex: .xsd, .dtd)
modelProvider = getModelProviderByURI(key);
}
if (modelProvider == null) {
return null;
}
CMDocument cmDocument = null;
boolean isCacheable = isCacheable(key);
if (isCacheable) {
cmDocument = cmDocumentCache.get(key);
}
if (cmDocument == null) {
XSModel model = loader.loadURI(key);
if (model != null) {
// XML Schema can be loaded
cmDocument = new XSDDocument(model);
if (isCacheable) {
cmDocumentCache.put(key, cmDocument);
}
cmDocument = modelProvider.createCMDocument(key);
if (isCacheable && cmDocument != null) {
cmDocumentCache.put(key, cmDocument);
}
}
return cmDocument;
}

/**
* Returns the content model provider by using standard association
* (xsi:schemaLocation, xsi:noNamespaceSchemaLocation, doctype) an dnull
* otherwise.
*
* @param xmlDocument
* @return the content model provider by using standard association
* (xsi:schemaLocation, xsi:noNamespaceSchemaLocation, doctype) an dnull
* otherwise.
*/
private ContentModelProvider getModelProviderByStandardAssociation(XMLDocument xmlDocument) {
for (ContentModelProvider modelProvider : modelProviders) {
if (modelProvider.adaptFor(xmlDocument)) {
return modelProvider;
}
}
return null;
}

private ContentModelProvider getModelProviderByURI(String uri) {
for (ContentModelProvider modelProvider : modelProviders) {
if (modelProvider.adaptFor(uri)) {
return modelProvider;
}
}
return null;
}

private boolean isCacheable(String uri) {
return !URIUtils.isFileResource(uri);
}
Expand Down Expand Up @@ -192,4 +191,12 @@ public void setUseCache(boolean useCache) {
cacheResolverExtension.setUseCache(useCache);
}

public void registerModelProvider(ContentModelProvider modelProvider) {
modelProviders.add(modelProvider);
}

public void unregisterModelProvider(ContentModelProvider modelProvider) {
modelProviders.remove(modelProvider);
}

}
38 changes: 38 additions & 0 deletions ...src/main/java/org/eclipse/lsp4xml/extensions/contentmodel/model/ContentModelProvider.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/**
* Copyright (c) 2018 Angelo ZERR
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Angelo Zerr <[email protected]> - initial API and implementation
*/
package org.eclipse.lsp4xml.extensions.contentmodel.model;

import org.eclipse.lsp4xml.dom.XMLDocument;

/**
* Content model provider API.
*
*/
public interface ContentModelProvider {

/**
* Returns the content model provider by using standard association
* (xsi:schemaLocation, xsi:noNamespaceSchemaLocation, doctype) an dnull
* otherwise.
*
* @param document
* @return the content model provider by using standard association
* (xsi:schemaLocation, xsi:noNamespaceSchemaLocation, doctype) an dnull
* otherwise.
*/
boolean adaptFor(XMLDocument document);

boolean adaptFor(String uri);

String getSystemId(XMLDocument xmlDocument, String namespaceURI);

CMDocument createCMDocument(String key);
}
45 changes: 45 additions & 0 deletions org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/DTDPlugin.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/**
* Copyright (c) 2018 Angelo ZERR.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Angelo Zerr <[email protected]> - initial API and implementation
*/
package org.eclipse.lsp4xml.extensions.dtd;

import org.eclipse.lsp4j.InitializeParams;
import org.eclipse.lsp4xml.extensions.contentmodel.model.ContentModelManager;
import org.eclipse.lsp4xml.extensions.contentmodel.model.ContentModelProvider;
import org.eclipse.lsp4xml.extensions.dtd.contentmodel.DTDContentModelProvider;
import org.eclipse.lsp4xml.services.extensions.IXMLExtension;
import org.eclipse.lsp4xml.services.extensions.XMLExtensionsRegistry;
import org.eclipse.lsp4xml.services.extensions.save.ISaveContext;

/**
* DTD plugin.
*/
public class DTDPlugin implements IXMLExtension {

public DTDPlugin() {
}

@Override
public void doSave(ISaveContext context) {

}

@Override
public void start(InitializeParams params, XMLExtensionsRegistry registry) {
// register DTD content model provider
ContentModelProvider modelProvider = new DTDContentModelProvider(registry.getResolverExtensionManager());
ContentModelManager modelManager = registry.getComponent(ContentModelManager.class);
modelManager.registerModelProvider(modelProvider);
}

@Override
public void stop(XMLExtensionsRegistry registry) {
}
}
Loading

0 comments on commit ce0240b

Please sign in to comment.