org.opencms.loader.CmsDefaultTemplateContextProvider Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (C) Alkacon Software (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.loader;
import org.opencms.cache.CmsVfsMemoryObjectCache;
import org.opencms.file.CmsFile;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsProperty;
import org.opencms.file.CmsPropertyDefinition;
import org.opencms.file.CmsResource;
import org.opencms.json.JSONObject;
import org.opencms.json.JSONTokener;
import org.opencms.jsp.util.I_CmsJspDeviceSelector;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.util.CmsMacroResolver;
import org.opencms.util.CmsStringUtil;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.logging.Log;
/**
* Example implementation of a template context provider for deciding between a desktop template and a mobile template.
*
* The template JSP paths are read from a VFS file "/system/config/templatecontexts.json"
*
*/
public class CmsDefaultTemplateContextProvider implements I_CmsTemplateContextProvider {
/** JSON attribute name. */
public static final String A_HEIGHT = "height";
/** JSON attribute name. */
public static final String A_NICE_NAME = "niceName";
/** JSON attribute name. */
public static final String A_PATH = "path";
/** JSON attribute name. */
public static final String A_VARIANTS = "variants";
/** JSON attribute name. */
public static final String A_WIDTH = "width";
/** The name for the configuration parameter which points to the template contexts configuration file. */
public static final String PARAM_CONFIGURATION = "configuration";
/** The logger instance for this class. */
private static final Log LOG = CmsLog.getLog(CmsDefaultTemplateContextProvider.class);
/** Cache for the template contexts. */
private CmsVfsMemoryObjectCache m_cache = new CmsVfsMemoryObjectCache();
/** The stored Cms context. */
private CmsObject m_cms;
/** Map of configuration parameters for the provider instance. */
private Map m_params;
/** Default constructor. */
public CmsDefaultTemplateContextProvider() {
}
/**
* @see org.opencms.loader.I_CmsTemplateContextProvider#getAllContexts()
*/
public synchronized Map getAllContexts() {
return Collections.unmodifiableMap(getContextMap());
}
/**
* Returns the absolute VFS path where the configuration property file is stored.
*
*
* @return the absolute VFS path where the configuration property file is stored
*/
public String getConfigurationPropertyPath() {
if (m_params.containsKey(PARAM_CONFIGURATION)) {
return m_params.get(PARAM_CONFIGURATION);
} else {
return OpenCms.getSystemInfo().getConfigFilePath(m_cms, "templatecontexts.json");
}
}
/**
* @see org.opencms.loader.I_CmsTemplateContextProvider#getEditorStyleSheet(org.opencms.file.CmsObject, java.lang.String)
*/
public String getEditorStyleSheet(CmsObject cms, String editedResourcePath) {
String templatePath = getAllContexts().get("desktop").getTemplatePath();
String result = null;
try {
CmsProperty property = cms.readPropertyObject(templatePath, CmsPropertyDefinition.PROPERTY_TEMPLATE, true);
if (!property.isNullProperty()) {
result = property.getValue();
}
} catch (CmsException e) {
LOG.error(e.getLocalizedMessage(), e);
}
return result;
}
/**
* @see org.opencms.loader.I_CmsTemplateContextProvider#getOverrideCookieName()
*/
public String getOverrideCookieName() {
return "templatecontext";
}
/**
* @see org.opencms.loader.I_CmsTemplateContextProvider#getTemplateContext(org.opencms.file.CmsObject, javax.servlet.http.HttpServletRequest, org.opencms.file.CmsResource)
*/
public synchronized CmsTemplateContext getTemplateContext(
CmsObject cms,
HttpServletRequest request,
CmsResource resource) {
I_CmsJspDeviceSelector selector = OpenCms.getSystemInfo().getDeviceSelector();
String deviceType = request != null ? selector.getDeviceType(request) : null;
Map contextMap = getAllContexts();
if ((deviceType != null) && contextMap.containsKey(deviceType)) {
return contextMap.get(deviceType);
} else {
return contextMap.get("desktop");
}
}
/**
* @see org.opencms.loader.I_CmsTemplateContextProvider#initialize(org.opencms.file.CmsObject, java.lang.String)
*/
public void initialize(CmsObject cms, String config) {
m_cms = cms;
if (CmsStringUtil.isEmptyOrWhitespaceOnly(config)) {
m_params = new HashMap();
} else {
m_params = CmsStringUtil.splitAsMap(config, ",", "=");
}
getAllContexts();
}
/**
* @see org.opencms.loader.I_CmsTemplateContextProvider#readCommonProperty(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
*/
public String readCommonProperty(CmsObject cms, String propertyName, String fallbackValue) throws CmsException {
String templatePath = getAllContexts().get("desktop").getTemplatePath();
return cms.readPropertyObject(templatePath, propertyName, false).getValue(fallbackValue);
}
/**
* Gets the context map, either from a cache or from the VFS if it'S not already cached.
*
* @return the context map
*/
@SuppressWarnings("unchecked")
private Map getContextMap() {
Object cachedObj = m_cache.getCachedObject(m_cms, getConfigurationPropertyPath());
if (cachedObj != null) {
return (Map)cachedObj;
} else {
try {
Map map = initMap();
m_cache.putCachedObject(m_cms, getConfigurationPropertyPath(), map);
return map;
} catch (Exception e) {
LOG.error(e.getLocalizedMessage(), e);
return Collections.emptyMap();
}
}
}
/**
* Loads the context map from the VFS.
*
* @return the context map
* @throws Exception if something goes wrong
*/
private Map initMap() throws Exception {
Map result = new LinkedHashMap();
String path = getConfigurationPropertyPath();
CmsResource resource = m_cms.readResource(path);
CmsFile file = m_cms.readFile(resource);
String fileContent = new String(file.getContents(), "UTF-8");
CmsMacroResolver resolver = new CmsMacroResolver();
resolver.setCmsObject(m_cms);
for (Map.Entry param : m_params.entrySet()) {
resolver.addMacro(param.getKey(), param.getValue());
}
fileContent = resolver.resolveMacros(fileContent);
JSONTokener tok = new JSONTokener(fileContent);
tok.setOrdered(true);
JSONObject root = new JSONObject(tok, true);
for (String templateContextName : root.keySet()) {
JSONObject templateContextJson = (JSONObject)(root.opt(templateContextName));
CmsJsonMessageContainer jsonMessage = new CmsJsonMessageContainer(templateContextJson.opt(A_NICE_NAME));
String templatePath = (String)templateContextJson.opt(A_PATH);
JSONObject variantsJson = (JSONObject)templateContextJson.opt(A_VARIANTS);
List variants = new ArrayList();
if (variantsJson != null) {
for (String variantName : variantsJson.keySet()) {
JSONObject variantJson = (JSONObject)variantsJson.opt(variantName);
CmsJsonMessageContainer variantMessage = new CmsJsonMessageContainer(variantJson.opt(A_NICE_NAME));
int width = variantJson.optInt(A_WIDTH, 800);
int height = variantJson.optInt(A_HEIGHT, 600);
CmsClientVariant variant = new CmsClientVariant(
variantName,
variantMessage,
width,
height,
new HashMap());
variants.add(variant);
}
}
CmsTemplateContext templateContext = new CmsTemplateContext(
templateContextName,
templatePath,
jsonMessage,
this,
variants,
false);
result.put(templateContextName, templateContext);
}
return result;
}
}