/*******************************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*******************************************************************************/
package org.ofbiz.widget.form;
import java.io.IOException;
import java.net.URL;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.xml.parsers.ParserConfigurationException;
import org.ofbiz.base.location.FlexibleLocation;
import org.ofbiz.base.util.UtilHttp;
import org.ofbiz.base.util.UtilXml;
import org.ofbiz.base.util.cache.UtilCache;
import org.ofbiz.entity.Delegator;
import org.ofbiz.entity.model.ModelReader;
import org.ofbiz.service.DispatchContext;
import org.ofbiz.service.LocalDispatcher;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.SAXException;
/**
* Widget Library - Form factory class
*/
public class FormFactory {
public static final String module = FormFactory.class.getName();
public static final UtilCache<String, ModelForm> formLocationCache = UtilCache.createUtilCache("widget.form.locationResource", 0, 0, false);
public static final UtilCache<String, ModelForm> formWebappCache = UtilCache.createUtilCache("widget.form.webappResource", 0, 0, false);
public static Map<String, ModelForm> getFormsFromLocation(String resourceName, ModelReader entityModelReader, DispatchContext dispatchContext)
throws IOException, SAXException, ParserConfigurationException {
/*
ClassLoader loader = Thread.currentThread().getContextClassLoader();
if (loader == null) {
loader = FormFactory.class.getClassLoader();
}
*/
URL formFileUrl = FlexibleLocation.resolveLocation(resourceName); //, loader);
Document formFileDoc = UtilXml.readXmlDocument(formFileUrl, true, true);
return readFormDocument(formFileDoc, entityModelReader, dispatchContext, resourceName);
}
public static ModelForm getFormFromLocation(String resourceName, String formName, ModelReader entityModelReader, DispatchContext dispatchContext)
throws IOException, SAXException, ParserConfigurationException {
String cacheKey = resourceName + "#" + formName;
ModelForm modelForm = formLocationCache.get(cacheKey);
if (modelForm == null) {
synchronized (formLocationCache) {
modelForm = formLocationCache.get(cacheKey);
if (modelForm == null) {
/*
ClassLoader loader = Thread.currentThread().getContextClassLoader();
if (loader == null) {
loader = FormFactory.class.getClassLoader();
}
*/
URL formFileUrl = FlexibleLocation.resolveLocation(resourceName); //, loader);
Document formFileDoc = UtilXml.readXmlDocument(formFileUrl, true, true);
if (formFileDoc == null) {
throw new IllegalArgumentException("Could not find resource [" + resourceName + "]");
}
modelForm = createModelForm(formFileDoc, entityModelReader, dispatchContext, resourceName, formName);
formLocationCache.put(cacheKey, modelForm);
}
}
}
if (modelForm == null) {
throw new IllegalArgumentException("Could not find form with name [" + formName + "] in class resource [" + resourceName + "]");
}
return modelForm;
}
public static ModelForm getFormFromWebappContext(String resourceName, String formName, HttpServletRequest request)
throws IOException, SAXException, ParserConfigurationException {
String webappName = UtilHttp.getApplicationName(request);
String cacheKey = webappName + "::" + resourceName + "::" + formName;
ModelForm modelForm = formWebappCache.get(cacheKey);
if (modelForm == null) {
synchronized (formWebappCache) {
modelForm = formWebappCache.get(cacheKey);
if (modelForm == null) {
ServletContext servletContext = (ServletContext) request.getAttribute("servletContext");
Delegator delegator = (Delegator) request.getAttribute("delegator");
LocalDispatcher dispatcher = (LocalDispatcher) request.getAttribute("dispatcher");
URL formFileUrl = servletContext.getResource(resourceName);
Document formFileDoc = UtilXml.readXmlDocument(formFileUrl, true, true);
Element formElement = UtilXml.firstChildElement(formFileDoc.getDocumentElement(), "form", "name", formName);
modelForm = new ModelForm(formElement, delegator.getModelReader(), dispatcher.getDispatchContext());
modelForm.setFormLocation(resourceName);
formWebappCache.put(cacheKey, modelForm);
}
}
}
if (modelForm == null) {
throw new IllegalArgumentException("Could not find form with name [" + formName + "] in webapp resource [" + resourceName + "] in the webapp [" + webappName + "]");
}
return modelForm;
}
public static Map<String, ModelForm> readFormDocument(Document formFileDoc, ModelReader entityModelReader, DispatchContext dispatchContext, String formLocation) {
Map<String, ModelForm> modelFormMap = new HashMap<String, ModelForm>();
if (formFileDoc != null) {
// read document and construct ModelForm for each form element
Element rootElement = formFileDoc.getDocumentElement();
List<? extends Element> formElements = UtilXml.childElementList(rootElement, "form");
for (Element formElement : formElements) {
String formName = formElement.getAttribute("name");
String cacheKey = formLocation + "#" + formName;
ModelForm modelForm = formLocationCache.get(cacheKey);
if (modelForm == null) {
synchronized (formLocationCache) {
modelForm = formLocationCache.get(cacheKey);
if (modelForm == null) {
modelForm = createModelForm(formElement, entityModelReader, dispatchContext, formLocation, formName);
formLocationCache.put(cacheKey, modelForm);
}
}
}
modelFormMap.put(formName, modelForm);
}
}
return modelFormMap;
}
public static ModelForm createModelForm(Document formFileDoc, ModelReader entityModelReader, DispatchContext dispatchContext, String formLocation, String formName) {
Element formElement = UtilXml.firstChildElement(formFileDoc.getDocumentElement(), "form", "name", formName);
return createModelForm(formElement, entityModelReader, dispatchContext, formLocation, formName);
}
public static ModelForm createModelForm(Element formElement, ModelReader entityModelReader, DispatchContext dispatchContext, String formLocation, String formName) {
ModelForm modelForm = new ModelForm(formElement, entityModelReader, dispatchContext);
modelForm.setFormLocation(formLocation);
return modelForm;
}
}