/*
* File : $Source: /alkacon/cvs/alkacon/com.alkacon.opencms.weboptimization/src/com/alkacon/opencms/weboptimization/CmsOptimizationJs.java,v $
* Date : $Date: 2010/01/08 09:46:05 $
* Version: $Revision: 1.3 $
*
* This file is part of the Alkacon OpenCms Add-On Module Package
*
* Copyright (c) 2007 Alkacon Software GmbH (http://www.alkacon.com)
*
* The Alkacon OpenCms Add-On Module Package is free software:
* you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* The Alkacon OpenCms Add-On Module Package 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with the Alkacon OpenCms Add-On Module Package.
* If not, see http://www.gnu.org/licenses/.
*
* For further information about Alkacon Software GmbH, please see the
* company website: http://www.alkacon.com.
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org.
*/
package com.alkacon.opencms.weboptimization;
import org.opencms.file.CmsFile;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.main.CmsIllegalArgumentException;
import org.opencms.xml.CmsXmlUtils;
import org.opencms.xml.content.CmsXmlContent;
import org.opencms.xml.content.CmsXmlContentFactory;
import org.opencms.xml.types.I_CmsXmlContentValue;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.jsp.PageContext;
import com.yahoo.platform.yui.compressor.JavaScriptCompressor;
/**
* Bean for optimizing js files.<p>
*
* @author Michael Moossen
*
* @version $Revision: 1.3 $
*
* @since 7.0.6
*/
public class CmsOptimizationJs extends CmsOptimizationBean {
/** src attribute constant. */
protected static final String ATTR_SRC = "src";
/** type attribute constant. */
protected static final String ATTR_TYPE = "type";
/** js file extension constant. */
protected static final String EXT_JS = ".js";
/** Node name constant. */
protected static final String N_MUNGE = "Munge";
/** Node name constant. */
protected static final String N_OPTIMIZE = "Optimize";
/** Node name constant. */
protected static final String N_PRESERVE_SEMI = "PreserveSemi";
/** Optimized js resource type constant. */
protected static final int RESOURCE_TYPE_JS = 762;
/** script tag constant. */
protected static final String TAG_SCRIPT = "script";
/** text/javascript type constant. */
protected static final String TYPE_TEXT_JS = "text/javascript";
/**
* Default constructor.<p>
*
* @param context the JSP page context object
* @param req the JSP request
* @param res the JSP response
*/
public CmsOptimizationJs(PageContext context, HttpServletRequest req, HttpServletResponse res) {
super(context, req, res);
}
/**
* @see com.alkacon.opencms.weboptimization.CmsOptimizationBean#includeDefault(java.lang.String,
* com.alkacon.opencms.weboptimization.CmsOptimizationBean.IncludeMode)
*/
@Override
public void includeDefault(String path, IncludeMode mode) throws Exception {
CmsObject cms = getCmsObject();
// check the resource type
CmsFile file = cms.readFile(path);
if (file.getTypeId() != RESOURCE_TYPE_JS) {
throw new CmsIllegalArgumentException(Messages.get().container(
Messages.ERR_NOT_SUPPORTED_RESOURCE_TYPE_2, path,
new Integer(file.getTypeId())));
}
if (mode == IncludeMode.OPTIMIZED) {
// if we are forcing optimization
// handle this resource
writeScriptInclude(cms, path);
return;
}
Resolution resolution = resolveInclude(cms, file, mode, EXT_JS, RESOURCE_TYPE_JS);
if (resolution.hasOptimizedLeft()) {
// handle this resource
writeScriptInclude(cms, path);
}
Iterator<CmsResource> itRes = resolution.getResources().iterator();
while (itRes.hasNext()) {
CmsResource res = itRes.next();
String resPath = cms.getSitePath(res);
// handle this resource
writeScriptInclude(cms, resPath);
}
}
/**
* Will optimize the resources taken from the underlying XML content.<p>
*
* @throws Exception if something goes wrong
*/
public void optimize() throws Exception {
CmsObject cms = getCmsObject();
CmsFile file = cms.readFile(cms.getRequestContext().getUri());
// check the resource type
if (file.getTypeId() != RESOURCE_TYPE_JS) {
throw new CmsIllegalArgumentException(Messages.get().container(
Messages.ERR_NOT_SUPPORTED_RESOURCE_TYPE_2,
cms.getRequestContext().getUri(),
new Integer(file.getTypeId())));
}
// read the XML content
CmsXmlContent xml = CmsXmlContentFactory.unmarshal(cms, file);
// resolve the locale
Locale locale = resolveLocale(cms, xml);
// cache the current project
boolean online = cms.getRequestContext().currentProject().isOnlineProject();
// iterate the resources
Iterator<I_CmsXmlContentValue> itRes = xml.getValues(N_RESOURCE, locale).iterator();
while (itRes.hasNext()) {
I_CmsXmlContentValue value = itRes.next();
if (!isOptimized(cms, xml, value, locale, online)) {
continue;
}
// get the path
String xpath = CmsXmlUtils.concatXpath(value.getPath(), N_PATH);
String path = xml.getValue(xpath, locale).getStringValue(cms);
// get the options
CmsOptimizationJsOptions opts = new CmsOptimizationJsOptions();
xpath = CmsXmlUtils.concatXpath(value.getPath(), N_OPTIONS);
if (xml.hasValue(xpath, locale)) {
value = xml.getValue(xpath, locale);
xpath = CmsXmlUtils.concatXpath(value.getPath(), N_LINE_BREAK_POS);
opts.setLineBreakPos(Integer.parseInt(xml.getStringValue(cms, xpath, locale)));
xpath = CmsXmlUtils.concatXpath(value.getPath(), N_PRESERVE_SEMI);
opts.setPreserveSemi(Boolean.parseBoolean(xml.getStringValue(cms, xpath, locale)));
xpath = CmsXmlUtils.concatXpath(value.getPath(), N_MUNGE);
opts.setMunge(Boolean.parseBoolean(xml.getStringValue(cms, xpath, locale)));
xpath = CmsXmlUtils.concatXpath(value.getPath(), N_OPTIMIZE);
opts.setOptimize(Boolean.parseBoolean(xml.getStringValue(cms, xpath, locale)));
}
// process this resource
optimizeJs(getAllContent(cms, path), opts);
}
}
/**
* Optimizes js code with the given options.<p>
*
* @param jsCode the code to compress
* @param options the options to use
*
* @throws Exception if something goes wrong
*/
public void optimizeJs(String jsCode, CmsOptimizationJsOptions options) throws Exception {
// default options
boolean verbose = false;
Reader reader = new BufferedReader(new StringReader(jsCode));
try {
// process the js code
JavaScriptCompressor jsc = new JavaScriptCompressor(reader, new CmsOptimizationJsErrorReporter());
jsc.compress(
getJspContext().getOut(),
options.getLineBreakPos(),
options.isMunge(),
verbose,
options.isPreserveSemi(),
!options.isOptimize());
} finally {
try {
reader.close();
} catch (Exception e) {
// ignore
}
}
}
/**
* Writes a new script tag for given resource.<p>
*
* @param cms the cms context
* @param uri the resource to include
*
* @throws IOException if something goes wrong
*/
public void writeScriptInclude(CmsObject cms, String uri) throws IOException {
Map<String,String> attrs = new HashMap<String, String>();
attrs.put(ATTR_SRC, link(uri));
attrs.put(ATTR_TYPE, TYPE_TEXT_JS);
getJspContext().getOut().println(createTag(TAG_SCRIPT, attrs, false));
}
}