org.efaps.update.schema.program.staticsource.AbstractStaticSourceCompiler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation
Show all versions of efaps-kernel Show documentation
eFaps is a framework used to map objects with or without attached files to
a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface.
The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.
/*
* Copyright 2003 - 2011 The eFaps Team
*
* Licensed 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.
*
* Revision: $Rev: 6210 $
* Last Changed: $Date: 2011-02-18 16:02:56 -0500 (Fri, 18 Feb 2011) $
* Last Changed By: $Author: [email protected] $
*/
package org.efaps.update.schema.program.staticsource;
import java.io.ByteArrayInputStream;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.efaps.ci.CIAdminProgram;
import org.efaps.ci.CIType;
import org.efaps.db.Checkin;
import org.efaps.db.Insert;
import org.efaps.db.Instance;
import org.efaps.db.MultiPrintQuery;
import org.efaps.db.QueryBuilder;
import org.efaps.db.Update;
import org.efaps.update.schema.program.jasperreport.JasperReportCompiler;
import org.efaps.util.EFapsException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Class used to compile JavaScript and style sheets.
*
* @author The eFaps Team
* @version $Id: AbstractStaticSourceCompiler.java 6210 2011-02-18 21:02:56Z [email protected] $
*/
public abstract class AbstractStaticSourceCompiler
{
/**
* Logging instance used in this class.
*/
protected static final Logger LOG = LoggerFactory.getLogger(AbstractStaticSourceCompiler.class);
/**
* Static Method that executes the method compile for the SubClasses
* CSSCompiler and JavaScriptCompiler.
* @param _classPathElements elements on the classpath
* @throws EFapsException on error
*/
public static void compileAll(final List _classPathElements)
throws EFapsException
{
(new JasperReportCompiler(_classPathElements)).compile();
(new CSSCompiler()).compile();
(new JavaScriptCompiler()).compile();
(new WikiCompiler()).compile();
}
/**
* This method is doing the actual compiling in the following steps.
* read all existing compiled source from the eFaps-DataBase read
* all sources from the eFaps-DataBase compile all sources
* (including the extending of any super type) and insert it into the
* eFaps-DataBase
*
* @throws EFapsException on error
*/
public void compile() throws EFapsException
{
final Map compiled = readCompiledSources();
final List allsource = readSources();
for (final AbstractSource onesource : allsource) {
if (AbstractStaticSourceCompiler.LOG.isInfoEnabled()) {
AbstractStaticSourceCompiler.LOG.info("compiling " + onesource.getName());
}
final List supers = getSuper(onesource.getInstance());
final StringBuilder builder = new StringBuilder();
while (!supers.isEmpty()) {
builder.append(getCompiledString(supers.get(supers.size() - 1)));
supers.remove(supers.size() - 1);
}
builder.append(getCompiledString(onesource.getInstance()));
final Update update;
if (compiled.containsKey(onesource.getName())) {
update = new Update(compiled.get(onesource.getName()));
} else {
update = new Insert(getClassName4TypeCompiled());
}
update.add("Name", onesource.getName());
update.add("ProgramLink", "" + onesource.getInstance().getId());
update.executeWithoutAccessCheck();
final Instance instance = update.getInstance();
update.close();
byte[] mybytes = null;
try {
mybytes = builder.toString().getBytes("UTF-8");
} catch (final UnsupportedEncodingException e) {
AbstractStaticSourceCompiler.LOG.error("error in reading Bytes from String using UTF-8", e);
}
final ByteArrayInputStream str = new ByteArrayInputStream(mybytes);
String name = onesource.getName().substring(0, onesource.getName().lastIndexOf("."));
name = name.substring(name.lastIndexOf(".") + 1)
+ onesource.getName().substring(onesource.getName().lastIndexOf("."));
final Checkin checkin = new Checkin(instance);
checkin.executeWithoutAccessCheck(name, str, mybytes.length);
}
}
/**
* Get the UUID for the CompiledType.
*
* @return UUID for the CompiledType
*/
protected abstract CIType getClassName4TypeCompiled();
/**
* Get the UUID for the Type.
*
* @return UUID for the Type
*/
protected abstract CIType getClassName4Type();
/**
* Get the UUID for the Type2Type.
*
* @return UUID for the Type2Type
*/
protected abstract CIType getClassName4Type2Type();
/**
* Get a new AbstractSource to instantiate.
*
* @see #AbstractSource
* @see #readSources()
* @param _name name of the source
* @param _instance Instance of the source
* @return AbstractSource
*/
protected abstract AbstractSource getNewSource(final String _name,
final Instance _instance);
/**
* Get the compiled String for the Instance with OID _oid.
*
* @param _instance the instance the compiled String will be returned
* @return a compiled String of the Instance
* @throws EFapsException on error
*/
protected abstract String getCompiledString(final Instance _instance)
throws EFapsException;
/**
* This method reads all compiled Sources from the eFaps-DataBase and
* returns a map with name to oid relation.
*
* @return Map with name to oid of the compiled source
* @throws EFapsException on error
*/
protected Map readCompiledSources()
throws EFapsException
{
final Map ret = new HashMap();
final QueryBuilder queryBldr = new QueryBuilder(getClassName4TypeCompiled());
final MultiPrintQuery multi = queryBldr.getPrint();
multi.addAttribute(CIAdminProgram.StaticCompiled.Name);
multi.executeWithoutAccessCheck();
while (multi.next()) {
final String name = multi.getAttribute(CIAdminProgram.StaticCompiled.Name);
ret.put(name, multi.getCurrentInstance().getOid());
}
return ret;
}
/**
* This method reads all Sources from the eFapsDataBase and returns for each
* Source a Instance of AbstractSource in a List.
*
* @return List with AbstractSources
* @throws EFapsException on error
*/
protected List readSources()
throws EFapsException
{
final List ret = new ArrayList();
final QueryBuilder queryBldr = new QueryBuilder(getClassName4Type());
final MultiPrintQuery multi = queryBldr.getPrint();
multi.addAttribute(CIAdminProgram.Abstract.Name);
multi.executeWithoutAccessCheck();
while (multi.next()) {
final String name = multi.getAttribute(CIAdminProgram.StaticCompiled.Name);
ret.add(getNewSource(name, multi.getCurrentInstance()));
}
return ret;
}
/**
* Recursive method that searches the SuperSource for the current Instance
* identified by the oid.
*
* @param _instance Instance the Super Instance will be searched
* @return List of SuperSources in reverse order
* @throws EFapsException error
*/
protected List getSuper(final Instance _instance)
throws EFapsException
{
final List ret = new ArrayList();
final QueryBuilder queryBldr = new QueryBuilder(getClassName4Type2Type());
queryBldr.addWhereAttrEqValue(CIAdminProgram.Program2Program.From, _instance.getId());
final MultiPrintQuery multi = queryBldr.getPrint();
multi.addAttribute(CIAdminProgram.Program2Program.To);
multi.execute();
if (multi.next()) {
final Instance instance = Instance.get(getClassName4Type().getType(),
multi.getAttribute(CIAdminProgram.Program2Program.To));
ret.add(instance);
ret.addAll(getSuper(instance));
}
return ret;
}
/**
* Class to access one source.
*/
protected abstract class AbstractSource
{
/**
* Stores the name of this source.
*/
private final String name;
/**
* Instance of this source.
*/
private final Instance instance;
/**
* Constructor setting all instance variables.
*
* @param _name name of the source
* @param _instance Instance of the source
*/
public AbstractSource(final String _name,
final Instance _instance)
{
this.name = _name;
this.instance = _instance;
}
/**
* This is the getter method for the instance variable {@link #name}.
*
* @return value of instance variable {@link #name}
*/
public String getName()
{
return this.name;
}
/**
* This is the getter method for the instance variable {@link #instance}.
*
* @return value of instance variable {@link #instance}
*/
public Instance getInstance()
{
return this.instance;
}
}
}