diff options
34 files changed, 89 insertions, 8107 deletions
diff --git a/WebContent/WEB-INF/web.xml b/WebContent/WEB-INF/web.xml index adad234158..21961382a7 100644 --- a/WebContent/WEB-INF/web.xml +++ b/WebContent/WEB-INF/web.xml @@ -13,7 +13,7 @@ <servlet>
<servlet-name>SelectDemo</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.SelectDemo</param-value>
@@ -22,7 +22,7 @@ <servlet>
<servlet-name>BufferedComponents</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.BufferedComponents</param-value>
@@ -31,7 +31,7 @@ <servlet>
<servlet-name>TableDemo</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.TableDemo</param-value>
@@ -40,7 +40,7 @@ <servlet>
<servlet-name>CustomLayoutDemo</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.CustomLayoutDemo</param-value>
@@ -49,7 +49,7 @@ <servlet>
<servlet-name>LayoutDemo</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.LayoutDemo</param-value>
@@ -58,7 +58,7 @@ <servlet>
<servlet-name>FilterSelect</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.FilterSelect</param-value>
@@ -67,7 +67,7 @@ <servlet>
<servlet-name>FeaturesApplication</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.features.FeaturesApplication</param-value>
@@ -76,7 +76,7 @@ <servlet>
<servlet-name>Parameters</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.Parameters</param-value>
@@ -85,7 +85,7 @@ <servlet>
<servlet-name>UpgradingSample</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.UpgradingSample</param-value>
@@ -94,7 +94,7 @@ <servlet>
<servlet-name>QueryContainerDemo</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.QueryContainerDemo</param-value>
@@ -103,7 +103,7 @@ <servlet>
<servlet-name>TreeFilesystemContainer</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.TreeFilesystemContainer</param-value>
@@ -120,7 +120,7 @@ <servlet>
<servlet-name>TreeFilesystem</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.TreeFilesystem</param-value>
@@ -137,7 +137,7 @@ <servlet>
<servlet-name>ModalWindow</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.ModalWindow</param-value>
@@ -146,7 +146,7 @@ <servlet>
<servlet-name>HelloWorld</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.HelloWorld</param-value>
@@ -155,7 +155,7 @@ <servlet>
<servlet-name>Calc</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.Calc</param-value>
@@ -164,7 +164,7 @@ <servlet>
<servlet-name>KeyboardShortcut</servlet-name>
- <servlet-class>com.itmill.toolkit.terminal.web.ApplicationServlet</servlet-class>
+ <servlet-class>com.itmill.toolkit.terminal.gwt.server.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.itmill.toolkit.demo.KeyboardShortcut</param-value>
diff --git a/src/com/itmill/toolkit/demo/features/IntroWelcome.java b/src/com/itmill/toolkit/demo/features/IntroWelcome.java index 75a643e1c4..89c0efb0cd 100644 --- a/src/com/itmill/toolkit/demo/features/IntroWelcome.java +++ b/src/com/itmill/toolkit/demo/features/IntroWelcome.java @@ -38,8 +38,8 @@ import com.itmill.toolkit.terminal.PaintException; import com.itmill.toolkit.terminal.PaintTarget; import com.itmill.toolkit.terminal.ParameterHandler; import com.itmill.toolkit.terminal.URIHandler; -import com.itmill.toolkit.terminal.web.ApplicationServlet; -import com.itmill.toolkit.terminal.web.WebBrowser; +import com.itmill.toolkit.terminal.gwt.server.ApplicationServlet; +import com.itmill.toolkit.terminal.gwt.server.WebBrowser; import com.itmill.toolkit.ui.Component; import com.itmill.toolkit.ui.Form; import com.itmill.toolkit.ui.Label; diff --git a/src/com/itmill/toolkit/terminal/web/AjaxHttpUploadStream.java b/src/com/itmill/toolkit/terminal/gwt/server/AjaxHttpUploadStream.java index d277bd16cd..e431d5126e 100644 --- a/src/com/itmill/toolkit/terminal/web/AjaxHttpUploadStream.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/AjaxHttpUploadStream.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import java.io.InputStream; @@ -36,7 +36,7 @@ import java.io.InputStream; * @author IT Mill Ltd. * @version * @VERSION@ - * @since 3.1 + * @since 5.0 */ public class AjaxHttpUploadStream implements com.itmill.toolkit.terminal.UploadStream { diff --git a/src/com/itmill/toolkit/terminal/web/AjaxVariableMap.java b/src/com/itmill/toolkit/terminal/gwt/server/AjaxVariableMap.java index 80980d8b69..54c0013361 100644 --- a/src/com/itmill/toolkit/terminal/web/AjaxVariableMap.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/AjaxVariableMap.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import java.io.IOException; import java.lang.ref.WeakReference; @@ -56,7 +56,7 @@ import com.itmill.toolkit.terminal.VariableOwner; * @author IT Mill Ltd. * @version * @VERSION@ - * @since 3.1 + * @since 5.0 */ public class AjaxVariableMap { @@ -145,7 +145,7 @@ public class AjaxVariableMap { // ---------- // TODO This HACK is only included for testing GWT integration //Original id = "v" + String.valueOf(++lastId); - Object pid = AjaxApplicationManager.paintableIdMap.get(owner); + Object pid = ApplicationManager.paintableIdMap.get(owner); id = pid + "_"+name; // ---------- diff --git a/src/com/itmill/toolkit/terminal/web/AjaxApplicationManager.java b/src/com/itmill/toolkit/terminal/gwt/server/ApplicationManager.java index 0b7d7f361e..3a3c27af53 100644 --- a/src/com/itmill/toolkit/terminal/web/AjaxApplicationManager.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/ApplicationManager.java @@ -26,9 +26,10 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import java.io.BufferedWriter; +import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; @@ -53,6 +54,7 @@ import java.util.WeakHashMap; import javax.servlet.ServletException; import javax.servlet.ServletOutputStream; +import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @@ -75,9 +77,9 @@ import com.itmill.toolkit.ui.Window; * @author IT Mill Ltd. * @version * @VERSION@ - * @since 3.1 + * @since 5.0 */ -public class AjaxApplicationManager implements +public class ApplicationManager implements Paintable.RepaintRequestListener, Application.WindowAttachListener, Application.WindowDetachListener { @@ -91,6 +93,7 @@ public class AjaxApplicationManager implements private HashSet dirtyPaintabletSet = new HashSet(); + // TODO THIS TEMPORARY HACK IS ONLY HERE TO MAKE GWT DEVEL EASIER static WeakHashMap paintableIdMap = new WeakHashMap(); @@ -100,14 +103,17 @@ public class AjaxApplicationManager implements private Set removedWindows = new HashSet(); - private PaintTarget paintTarget; + private JsonPaintTarget paintTarget; private List locales; private int pendingLocalesIndex; + + private ApplicationServlet applicationServlet; - public AjaxApplicationManager(Application application) { + public ApplicationManager(Application application, ApplicationServlet applicationServlet) { this.application = application; + this.applicationServlet = applicationServlet; requireLocale(application.getLocale().toString()); } @@ -146,25 +152,7 @@ public class AjaxApplicationManager implements public void handleUidlRequest(HttpServletRequest request, - HttpServletResponse response, ThemeSource themeSource) throws IOException { - handleUidlRequest(request, - response, themeSource, false); - - } - - - /** - * - * @param request - * the HTTP Request. - * @param response - * the HTTP Response. - * @throws IOException - * if the writing failed due to input/output error. - */ - public void handleUidlRequest(HttpServletRequest request, - HttpServletResponse response, ThemeSource themeSource, boolean isJson) - throws IOException { + HttpServletResponse response) throws IOException { // repaint requested or sesssion has timed out and new one is created boolean repaintAll = (request.getParameter(GET_PARAM_REPAINT_ALL) != null) @@ -222,7 +210,7 @@ public class AjaxApplicationManager implements response.setContentType("application/json; charset=UTF-8"); outWriter.print("\"changes\":["); - paintTarget = new AjaxJsonPaintTarget(getVariableMap(), + paintTarget = new JsonPaintTarget(getVariableMap(), this, outWriter); // Paints components @@ -309,11 +297,11 @@ public class AjaxApplicationManager implements paintTarget.addAttribute("pid", pid); // Track paints to identify empty paints - ((AjaxPaintTarget) paintTarget).setTrackPaints(true); + paintTarget.setTrackPaints(true); p.paint(paintTarget); // If no paints add attribute empty - if (((AjaxPaintTarget) paintTarget).getNumberOfPaints() <= 0) { + if (paintTarget.getNumberOfPaints() <= 0) { paintTarget.addAttribute("visible", false); } paintTarget.endTag("change"); @@ -321,7 +309,8 @@ public class AjaxApplicationManager implements } } - ((AjaxPaintTarget) paintTarget).close(); + + paintTarget.close(); outWriter.print("]"); // close changes @@ -368,12 +357,12 @@ public class AjaxApplicationManager implements String themeName = application.getTheme() != null ? application.getTheme() : ApplicationServlet.DEFAULT_THEME; // TODO We should only precache the layouts that are not cached already int resourceIndex = 0; - for (Iterator i=((AjaxPaintTarget) paintTarget).getPreCachedResources().iterator(); i.hasNext();) { + for (Iterator i=paintTarget.getPreCachedResources().iterator(); i.hasNext();) { String resource = (String) i.next(); InputStream is = null; try { - is = themeSource.getResource(themeName + "/" + resource); - } catch (ThemeSource.ThemeException e) { + is = applicationServlet.getServletContext().getResourceAsStream(ApplicationServlet.THEME_DIRECTORY_PATH + themeName + "/" + resource); + } catch (Exception e) { Log.info(e.getMessage()); } if (is != null) { @@ -392,7 +381,7 @@ public class AjaxApplicationManager implements Log.info("Resource transfer failed: " + request.getRequestURI() + ". (" + e.getMessage() + ")"); } - outWriter.print("\"" + AjaxJsonPaintTarget.escapeJSON(layout.toString()) + "\""); + outWriter.print("\"" + JsonPaintTarget.escapeJSON(layout.toString()) + "\""); } } outWriter.print("}"); diff --git a/src/com/itmill/toolkit/terminal/web/ApplicationServlet.java b/src/com/itmill/toolkit/terminal/gwt/server/ApplicationServlet.java index 525d9f91b6..62c561b480 100644 --- a/src/com/itmill/toolkit/terminal/web/ApplicationServlet.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/ApplicationServlet.java @@ -26,33 +26,23 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; -import java.io.BufferedReader; import java.io.BufferedWriter; -import java.io.File; -import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; -import java.io.InputStreamReader; import java.io.OutputStream; import java.io.OutputStreamWriter; -import java.io.PrintWriter; import java.net.MalformedURLException; import java.net.URL; -import java.util.Arrays; -import java.util.Collection; import java.util.Date; import java.util.Enumeration; import java.util.HashMap; import java.util.Iterator; import java.util.LinkedList; -import java.util.List; import java.util.Map; import java.util.Properties; import java.util.Set; -import java.util.StringTokenizer; -import java.util.Vector; import java.util.WeakHashMap; import javax.servlet.ServletContext; @@ -67,8 +57,6 @@ import javax.servlet.http.HttpSessionBindingListener; import org.xml.sax.SAXException; import com.itmill.toolkit.Application; -import com.itmill.toolkit.Application.WindowAttachEvent; -import com.itmill.toolkit.Application.WindowDetachEvent; import com.itmill.toolkit.service.FileTypeResolver; import com.itmill.toolkit.service.License; import com.itmill.toolkit.service.License.InvalidLicenseFile; @@ -80,9 +68,6 @@ import com.itmill.toolkit.terminal.Paintable; import com.itmill.toolkit.terminal.ParameterHandler; import com.itmill.toolkit.terminal.ThemeResource; import com.itmill.toolkit.terminal.URIHandler; -import com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent; -import com.itmill.toolkit.terminal.web.ThemeSource.ThemeException; -import com.itmill.toolkit.terminal.web.WebBrowser; import com.itmill.toolkit.ui.Window; /** @@ -95,9 +80,7 @@ import com.itmill.toolkit.ui.Window; * @since 4.0 */ -public class ApplicationServlet extends HttpServlet implements - Application.WindowAttachListener, Application.WindowDetachListener, - Paintable.RepaintRequestListener { +public class ApplicationServlet extends HttpServlet { private static final long serialVersionUID = -4937882979845826574L; @@ -124,7 +107,7 @@ public class ApplicationServlet extends HttpServlet implements /* Initialize version numbers from string replaced by build-script. */ static { if ("@VERSION@".equals("@" + "VERSION" + "@")) - VERSION = "4.0.0-INTERNAL-NONVERSIONED-DEBUG-BUILD"; + VERSION = "4.9.9-INTERNAL-NONVERSIONED-DEBUG-BUILD"; else VERSION = "@VERSION@"; String[] digits = VERSION.split("\\."); @@ -136,22 +119,8 @@ public class ApplicationServlet extends HttpServlet implements // Configurable parameter names private static final String PARAMETER_DEBUG = "Debug"; - private static final String PARAMETER_DEFAULT_THEME_JAR = "DefaultThemeJar"; - - private static final String PARAMETER_THEMESOURCE = "ThemeSource"; - - private static final String PARAMETER_THEME_CACHETIME = "ThemeCacheTime"; - - private static final String PARAMETER_MAX_TRANSFORMERS = "MaxTransformers"; - - private static final String PARAMETER_TRANSFORMER_CACHETIME = "TransformerCacheTime"; - - private static final int DEFAULT_THEME_CACHETIME = 1000 * 60 * 60 * 24; - private static final int DEFAULT_BUFFER_SIZE = 32 * 1024; - private static final int DEFAULT_MAX_TRANSFORMERS = 1; - private static final int MAX_BUFFER_SIZE = 64 * 1024; // TODO: these should be moved to session object and stored directly into @@ -164,10 +133,6 @@ public class ApplicationServlet extends HttpServlet implements private static final String SESSION_BINDING_LISTENER = "itmill-toolkit-bindinglistener"; - private static HashMap applicationToDirtyWindowSetMap = new HashMap(); - - private static HashMap applicationToServerCommandStreamLock = new HashMap(); - private static HashMap applicationToLastRequestDate = new HashMap(); private static HashMap applicationToAjaxAppMgrMap = new HashMap(); @@ -184,46 +149,21 @@ public class ApplicationServlet extends HttpServlet implements private static final String AJAX_UIDL_URI = "/UIDL/"; - private static final String THEME_DIRECTORY_PATH = "/theme/"; - - private static final String THEME_LISTING_FILE = THEME_DIRECTORY_PATH - + "themes.txt"; - - private static final String DEFAULT_THEME_JAR_PREFIX = "itmill-toolkit-themes"; - - private static final String DEFAULT_THEME_JAR = "/WEB-INF/lib/" - + DEFAULT_THEME_JAR_PREFIX + "-" + VERSION + ".jar"; - - private static final String DEFAULT_THEME_TEMP_FILE_PREFIX = "ITMILL_TMP_"; - - private static final String SERVER_COMMAND_PARAM = "SERVER_COMMANDS"; - - private static final int SERVER_COMMAND_STREAM_MAINTAIN_PERIOD = 15000; - - private static final int SERVER_COMMAND_HEADER_PADDING = 2000; + static final String THEME_DIRECTORY_PATH = "/theme/"; // Maximum delay between request for an user to be considered active (in ms) private static final long ACTIVE_USER_REQUEST_INTERVAL = 1000 * 45; - + + private static final int DEFAULT_THEME_CACHETIME = 1000 * 60 * 60 * 24; // Private fields private Class applicationClass; private Properties applicationProperties; - private UIDLTransformerFactory transformerFactory; - - private CollectionThemeSource themeSource; - private String resourcePath = null; private String debugMode = ""; - private int maxConcurrentTransformers; - - private long transformerCacheTime; - - private long themeCacheTime; - /** * Called by the servlet container to indicate to a servlet that the servlet * is being placed into service. @@ -275,70 +215,6 @@ public class ApplicationServlet extends HttpServlet implements "If debug parameter is given for an application, it must be 'true' or 'false'"); this.debugMode = debug; - // Gets the maximum number of simultaneous transformers - this.maxConcurrentTransformers = Integer - .parseInt(getApplicationOrSystemProperty( - PARAMETER_MAX_TRANSFORMERS, "-1")); - if (this.maxConcurrentTransformers < 1) - this.maxConcurrentTransformers = DEFAULT_MAX_TRANSFORMERS; - - // Gets cache time for transformers - this.transformerCacheTime = Integer - .parseInt(getApplicationOrSystemProperty( - - PARAMETER_TRANSFORMER_CACHETIME, "-1")) * 1000; - - // Gets cache time for theme resources - this.themeCacheTime = Integer.parseInt(getApplicationOrSystemProperty( - PARAMETER_THEME_CACHETIME, "-1")) * 1000; - if (this.themeCacheTime < 0) { - this.themeCacheTime = DEFAULT_THEME_CACHETIME; - } - - // Adds all specified theme sources - this.themeSource = new CollectionThemeSource(); - List directorySources = getThemeSources(); - for (Iterator i = directorySources.iterator(); i.hasNext();) { - this.themeSource.add((ThemeSource) i.next()); - } - - // Adds the default theme source - String[] defaultThemeFiles = new String[] { getApplicationOrSystemProperty( - PARAMETER_DEFAULT_THEME_JAR, DEFAULT_THEME_JAR) }; - File f = findDefaultThemeJar(defaultThemeFiles); - boolean defaultThemeFound = false; - try { - // Adds themes.jar if exists - if (f != null && f.exists()) { - this.themeSource.add(new JarThemeSource(f, this, "")); - defaultThemeFound = true; - } - } catch (Exception e) { - throw new ServletException("Failed to load default theme from " - + Arrays.asList(defaultThemeFiles), e); - } - - // Checks that at least one themesource was loaded - if (this.themeSource.getThemes().size() <= 0) { - throw new ServletException( - "No themes found in specified themesources. " - + Theme.MESSAGE_CONFIGURE_HELP); - } - - // Warn if default theme not found - if (this.themeSource.getThemeByName(DEFAULT_THEME) == null) { - if (!defaultThemeFound) - Log.warn("Default theme JAR not found in: " - + Arrays.asList(defaultThemeFiles)); - } - - // Initializes the transformer factory, if not initialized - if (this.transformerFactory == null) { - this.transformerFactory = new UIDLTransformerFactory( - this.themeSource, this, this.maxConcurrentTransformers, - this.transformerCacheTime); - } - // Loads the application class using the same class loader // as the servlet itself ClassLoader loader = this.getClass().getClassLoader(); @@ -401,109 +277,6 @@ public class ApplicationServlet extends HttpServlet implements } /** - * Gets ThemeSources from given path. Construct the list of avalable themes - * in path using the following sources: - * <p> - * 1. Content of <code>THEME_PATH</code> directory (if available). - * </p> - * <p> - * 2. The themes listed in <code>THEME_LIST_FILE</code>. - * </p> - * <p> - * 3. "themesource" application parameter - "ThemeSource" system property. - * </p> - * - * @return the List - * @throws ServletException - * if an exception has occurred that interferes with the - * servlet's normal operation. - */ - private List getThemeSources() throws ServletException { - - List returnValue = new LinkedList(); - - // Check the list file in theme directory - List sourcePaths = new LinkedList(); - try { - BufferedReader reader = new BufferedReader(new InputStreamReader( - this.getServletContext().getResourceAsStream( - THEME_LISTING_FILE))); - String line = null; - while ((line = reader.readLine()) != null) { - sourcePaths.add(THEME_DIRECTORY_PATH + line.trim()); - } - if (this.isDebugMode(null)) { - Log.debug("Listed " + sourcePaths.size() + " themes in " - + THEME_LISTING_FILE + ". Loading " + sourcePaths); - } - } catch (Exception ignored) { - // If the file reading fails, just skip to next method - } - - // If no file was found or it was empty, - // try to add themes filesystem directory if it is accessible - if (sourcePaths.size() <= 0) { - if (this.isDebugMode(null)) { - Log.debug("No themes listed in " + THEME_LISTING_FILE - + ". Trying to read the content of directory " - + THEME_DIRECTORY_PATH); - } - - try { - String path = getResourcePath(getServletContext(), - THEME_DIRECTORY_PATH); - if (path != null) { - File f = new File(path); - if (f != null && f.exists()) - returnValue.add(new DirectoryThemeSource(f, this)); - } - } catch (java.io.IOException je) { - Log.info("Theme directory " + THEME_DIRECTORY_PATH - + " not available. Skipped."); - } catch (ThemeException e) { - throw new ServletException("Failed to load themes from " - + THEME_DIRECTORY_PATH, e); - } - } - - // Adds the theme sources from application properties - String paramValue = getApplicationOrSystemProperty( - PARAMETER_THEMESOURCE, null); - if (paramValue != null) { - StringTokenizer st = new StringTokenizer(paramValue, ";"); - while (st.hasMoreTokens()) { - sourcePaths.add(st.nextToken()); - } - } - - // Constructs appropriate theme source instances for each path - for (Iterator i = sourcePaths.iterator(); i.hasNext();) { - String source = (String) i.next(); - File sourceFile = new File(source); - try { - // Relative files are treated as streams (to support - // resource inside WAR files) - if (!sourceFile.isAbsolute()) { - returnValue.add(new ServletThemeSource(this - .getServletContext(), this, source)); - } else if (sourceFile.isDirectory()) { - // Absolute directories are read from filesystem - returnValue.add(new DirectoryThemeSource(sourceFile, this)); - } else { - // Absolute JAR-files are read from filesystem - returnValue.add(new JarThemeSource(sourceFile, this, "")); - } - } catch (Exception e) { - // Any exception breaks the the init - throw new ServletException("Invalid theme source: " + source, e); - } - } - - // Returns the constructed list of theme sources - return returnValue; - } - - /** * Receives standard HTTP requests from the public service method and * dispatches them. * @@ -523,21 +296,11 @@ public class ApplicationServlet extends HttpServlet implements HttpServletResponse response) throws ServletException, IOException { // Transformer and output stream for the result - UIDLTransformer transformer = null; HttpVariableMap variableMap = null; OutputStream out = response.getOutputStream(); - HashMap currentlyDirtyWindowsForThisApplication = new HashMap(); Application application = null; try { - // Handles resource requests - if (handleResourceRequest(request, response)) - return; - - // Handles server commands - if (handleServerCommands(request, response)) - return; - // Gets the application application = getApplication(request); @@ -566,7 +329,7 @@ public class ApplicationServlet extends HttpServlet implements String resourceId = request.getPathInfo(); if (resourceId != null && resourceId.startsWith(AJAX_UIDL_URI)) { getApplicationManager(application).handleUidlRequest( - request, response, themeSource, true); + request, response); return; } @@ -593,8 +356,7 @@ public class ApplicationServlet extends HttpServlet implements detect = ((String) ((Object[]) unhandledParameters .get("renderingMode"))[0]).equals("detect"); } - if (detect - || wb.getRenderingMode() == WebBrowser.RENDERING_MODE_UNDEFINED) { + if (detect) { String themeName = application.getTheme(); if (themeName == null) themeName = DEFAULT_THEME; @@ -602,31 +364,8 @@ public class ApplicationServlet extends HttpServlet implements themeName = (String) ((Object[]) unhandledParameters .get("theme"))[0]; } - - Theme theme = themeSource.getThemeByName(themeName); - if (theme == null) - throw new ServletException( - "Failed to load theme with name " + themeName - + ". " + Theme.MESSAGE_CONFIGURE_HELP); - - String renderingMode = theme.getPreferredMode(wb, - themeSource); - if (Theme.MODE_AJAX.equals(renderingMode)) { - wb.setRenderingMode(WebBrowser.RENDERING_MODE_AJAX); - } else { - wb.setRenderingMode(WebBrowser.RENDERING_MODE_HTML); - } - } - if (unhandledParameters.get("renderingMode") != null) { - String renderingMode = (String) ((Object[]) unhandledParameters - .get("renderingMode"))[0]; - if (renderingMode.equals("html")) { - wb.setRenderingMode(WebBrowser.RENDERING_MODE_HTML); - } else if (renderingMode.equals("ajax")) { - wb.setRenderingMode(WebBrowser.RENDERING_MODE_AJAX); - } } - + // Handles the URI if the application is still running if (application.isRunning()) download = handleURI(application, request, response); @@ -670,15 +409,7 @@ public class ApplicationServlet extends HttpServlet implements BufferedWriter page = new BufferedWriter( new OutputStreamWriter(out)); page.write("<html><head><script>"); - page - .write(ThemeFunctionLibrary - .generateWindowScript( - null, - application, - this, - WebBrowserProbe - .getTerminalType(request - .getSession()))); + // WAS GENERATE WINDOW SCRIPT page.write("</script></head><body>"); page .write("The requested window has been removed from application."); @@ -700,136 +431,23 @@ public class ApplicationServlet extends HttpServlet implements themeName = (String) ((Object[]) unhandledParameters .get("theme"))[0]; } - Theme theme = themeSource.getThemeByName(themeName); - if (theme == null) - throw new ServletException("Theme (named '" + themeName - + "') can not be found"); - - // If in ajax rendering mode, print an html page for it - if (wb.getRenderingMode() == WebBrowser.RENDERING_MODE_AJAX) { - writeAjaxPage(request, response, out, - unhandledParameters, window, wb, theme); - return; - } - - // If other than html or ajax mode is requested - if (wb.getRenderingMode() == WebBrowser.RENDERING_MODE_UNDEFINED - && !(window instanceof DebugWindow)) { - // TODO More informal message should be given to browser - response.setContentType("text/html"); - BufferedWriter page = new BufferedWriter( - new OutputStreamWriter(out)); - page.write("<html><head></head><body>"); - page.write("Unsupported browser."); - page.write("</body></html>"); - page.close(); - + + // Handles resource requests + if (handleResourceRequest(request, response, themeName)) return; - } - - // Initialize Transformer - UIDLTransformerType transformerType = new UIDLTransformerType( - wb, theme); - - transformer = this.transformerFactory - .getTransformer(transformerType); - - // Sets the response type - response.setContentType(wb.getContentType()); - - // Creates UIDL writer - WebPaintTarget paintTarget = transformer - .getPaintTarget(variableMap); - - // Assures that the correspoding debug window will be - // repainted property - // by clearing it before the actual paint. - DebugWindow debugWindow = (DebugWindow) application - .getWindow(DebugWindow.WINDOW_NAME); - if (debugWindow != null && debugWindow != window) { - debugWindow.setWindowUIDL(window, "Painting..."); - } - - // Paints window - window.paint(paintTarget); - paintTarget.close(); - - // For exception handling, memorize the current dirty status - HashMap dirtyWindows = (HashMap) applicationToDirtyWindowSetMap - .get(application); - - if (dirtyWindows == null) { - dirtyWindows = new HashMap(); - applicationToDirtyWindowSetMap.put(application, - dirtyWindows); - } - currentlyDirtyWindowsForThisApplication - .putAll((Map) dirtyWindows); - - // Window is now painted - windowPainted(application, window); - - // Debug - if (debugWindow != null && debugWindow != window) { - debugWindow - .setWindowUIDL(window, paintTarget.getUIDL()); - } - - // Sets the function library state for this thread - ThemeFunctionLibrary.setState(application, window, - transformerType.getWebBrowser(), request - .getSession(), this, transformerType - .getTheme().getName()); + + writeAjaxPage(request, response, out, + unhandledParameters, window, wb, themeName); } } // For normal requests, transform the window - if (download == null) { - - // Transform and output the result to browser - // Note that the transform and transfer of the result is - // not synchronized with the variable map. This allows - // parallel transfers and transforms for better performance, - // but requires that all calls from the XSL to java are - // thread-safe - transformer.transform(out); - } - - // For download request, transfer the downloaded data - else { + if (download != null) handleDownload(download, request, response); - } - - } catch (UIDLTransformerException te) { - // Print stacktrace - te.printStackTrace(); - - try { - // Writes the error report to client - response.setContentType("text/html"); - BufferedWriter err = new BufferedWriter(new OutputStreamWriter( - out)); - err - .write("<html><head><title>Application Internal Error</title></head><body>"); - err.write("<h1>" + te.getMessage() + "</h1>"); - err.write(te.getHTMLDescription()); - err.write("</body></html>"); - err.close(); - } catch (Throwable t) { - Log.except("Failed to write error page: " + t - + ". Original exception was: ", te); - } + - // Adds previously dirty windows to dirtyWindowList in order - // to make sure that eventually they are repainted - Application currentApplication = getApplication(request); - for (Iterator iter = currentlyDirtyWindowsForThisApplication - .keySet().iterator(); iter.hasNext();) { - Window dirtyWindow = (Window) iter.next(); - addDirtyWindow(currentApplication, dirtyWindow); - } } catch (Throwable e) { // Print stacktrace @@ -838,18 +456,10 @@ public class ApplicationServlet extends HttpServlet implements throw new ServletException(e); } finally { - // Releases transformer - if (transformer != null) - transformerFactory.releaseTransformer(transformer); - // Notifies transaction end if (application != null) ((WebApplicationContext) application.getContext()) .endTransaction(application, request); - - // Cleans the function library state for this thread - // for security reasons - ThemeFunctionLibrary.cleanState(); } } @@ -872,8 +482,7 @@ public class ApplicationServlet extends HttpServlet implements */ private void writeAjaxPage(HttpServletRequest request, HttpServletResponse response, OutputStream out, - Map unhandledParameters, Window window, WebBrowser terminalType, - Theme theme) throws IOException, MalformedURLException { + Map unhandledParameters, Window window, WebBrowser terminalType, String themeName) throws IOException, MalformedURLException { response.setContentType("text/html"); BufferedWriter page = new BufferedWriter(new OutputStreamWriter(out)); @@ -902,7 +511,7 @@ public class ApplicationServlet extends HttpServlet implements page.write("'\n};\n" + "</script>\n" + - "<link REL=\"stylesheet\" TYPE=\"text/css\" HREF=\""+request.getContextPath() + "/theme/"+theme.getName()+"/style.css\">" + + "<link REL=\"stylesheet\" TYPE=\"text/css\" HREF=\""+request.getContextPath() + THEME_DIRECTORY_PATH+themeName+"/style.css\">" + "</head>\n<body>\n<script language=\"javascript\" src=\"/tk/com.itmill.toolkit.terminal.gwt.Client/gwt.js\"></script>\n" + " <iframe id=\"__gwt_historyFrame\" style=\"width:0;height:0;border:0\"></iframe>\n" + " <div id=\"itmtk-ajax-window\"></div>" + @@ -1086,86 +695,7 @@ public class ApplicationServlet extends HttpServlet implements } } - - /** - * Looks for default theme JAR file. - * - * @param fileList - * @return Jar file or null if not found. - */ - private File findDefaultThemeJar(String[] fileList) { - - // Try to find the default theme JAR file based on the given path - for (int i = 0; i < fileList.length; i++) { - String path = getResourcePath(getServletContext(), fileList[i]); - File file = null; - if (path != null && (file = new File(path)).exists()) { - return file; - } - } - - // If we do not have access to individual files, create a temporary - // file from named resource. - for (int i = 0; i < fileList.length; i++) { - InputStream defaultTheme = this.getServletContext() - .getResourceAsStream(fileList[i]); - // Read the content to temporary file and return it - if (defaultTheme != null) { - return createTemporaryFile(defaultTheme, ".jar"); - } - } - - // Try to find the default theme JAR file based on file naming scheme - // NOTE: This is for backward compability with 3.0.2 and earlier. - String path = getResourcePath(getServletContext(), "/WEB-INF/lib"); - if (path != null) { - File lib = new File(path); - String[] files = lib.list(); - if (files != null) { - for (int i = 0; i < files.length; i++) { - if (files[i].toLowerCase().endsWith(".jar") - && files[i].startsWith(DEFAULT_THEME_JAR_PREFIX)) { - return new File(lib, files[i]); - } - } - } - } - - // If no file was found return null - return null; - } - - /** - * Creates a temporary file for given stream. - * - * @param stream - * the Stream to be stored into temporary file. - * @param extension - * the File type extension. - * @return the temporary File. - */ - private File createTemporaryFile(InputStream stream, String extension) { - File tmpFile; - try { - tmpFile = File.createTempFile(DEFAULT_THEME_TEMP_FILE_PREFIX, - extension); - FileOutputStream out = new FileOutputStream(tmpFile); - byte[] buf = new byte[1024]; - int bytes = 0; - while ((bytes = stream.read(buf)) > 0) { - out.write(buf, 0, bytes); - } - out.close(); - } catch (IOException e) { - System.err - .println("Failed to create temporary file for default theme: " - + e); - tmpFile = null; - } - - return tmpFile; - } - + /** * Handles theme resource file requests. Resources supplied with the themes * are provided by the WebAdapterServlet. @@ -1182,7 +712,7 @@ public class ApplicationServlet extends HttpServlet implements * servlet's normal operation. */ private boolean handleResourceRequest(HttpServletRequest request, - HttpServletResponse response) throws ServletException { + HttpServletResponse response, String themeName) throws ServletException { // If the resource path is unassigned, initialize it if (resourcePath == null) { @@ -1201,10 +731,11 @@ public class ApplicationServlet extends HttpServlet implements // Checks the resource type resourceId = resourceId.substring(RESOURCE_URI.length()); InputStream data = null; + // Gets theme resources try { - data = themeSource.getResource(resourceId); - } catch (ThemeSource.ThemeException e) { + data = getServletContext().getResourceAsStream(THEME_DIRECTORY_PATH + themeName + "/" + resourceId); + } catch (Exception e) { Log.info(e.getMessage()); data = null; } @@ -1216,16 +747,15 @@ public class ApplicationServlet extends HttpServlet implements .getMIMEType(resourceId)); // Use default cache time for theme resources - if (this.themeCacheTime > 0) { response.setHeader("Cache-Control", "max-age=" - + this.themeCacheTime / 1000); + + DEFAULT_THEME_CACHETIME / 1000); response.setDateHeader("Expires", System .currentTimeMillis() - + this.themeCacheTime); + + DEFAULT_THEME_CACHETIME); response.setHeader("Pragma", "cache"); // Required to apply // caching in some // Tomcats - } + // Writes the data to client byte[] buffer = new byte[DEFAULT_BUFFER_SIZE]; int bytesRead = 0; @@ -1421,10 +951,6 @@ public class ApplicationServlet extends HttpServlet implements application = (Application) this.applicationClass.newInstance(); applications.add(application); - // Listens to window add/removes (for web mode) - application.addListener((Application.WindowAttachListener) this); - application.addListener((Application.WindowDetachListener) this); - // Sets locale application.setLocale(request.getLocale()); @@ -1666,29 +1192,6 @@ public class ApplicationServlet extends HttpServlet implements return null; } } - // Creates and open new debug window for application if requested - Window debugWindow = application.getWindow(DebugWindow.WINDOW_NAME); - if (debugWindow == null) { - if (isDebugMode(params) - && WebBrowserProbe.getTerminalType(request.getSession()) - .getRenderingMode() != WebBrowser.RENDERING_MODE_AJAX) { - try { - debugWindow = new DebugWindow(application, request - .getSession(false), this); - debugWindow.setWidth(370); - debugWindow.setHeight(480); - application.addWindow(debugWindow); - } catch (Exception e) { - throw new ServletException( - "Failed to create debug window for application", e); - } - } - } else if (window != debugWindow) { - if (isDebugMode(params)) - debugWindow.requestRepaint(); - else - application.removeWindow(debugWindow); - } return window; } @@ -1728,245 +1231,6 @@ public class ApplicationServlet extends HttpServlet implements } /** - * Returns the theme source. - * - * @return ThemeSource - */ - public ThemeSource getThemeSource() { - return themeSource; - } - - /** - * - * @param application - * @param window - */ - protected void addDirtyWindow(Application application, Window window) { - synchronized (applicationToDirtyWindowSetMap) { - HashMap dirtyWindows = (HashMap) applicationToDirtyWindowSetMap - .get(application); - if (dirtyWindows == null) { - dirtyWindows = new HashMap(); - applicationToDirtyWindowSetMap.put(application, dirtyWindows); - } - dirtyWindows.put(window, Boolean.TRUE); - } - } - - /** - * - * @param application - * @param window - */ - protected void removeDirtyWindow(Application application, Window window) { - synchronized (applicationToDirtyWindowSetMap) { - HashMap dirtyWindows = (HashMap) applicationToDirtyWindowSetMap - .get(application); - if (dirtyWindows != null) - dirtyWindows.remove(window); - } - } - - /** - * @see com.itmill.toolkit.Application.WindowAttachListener#windowAttached(Application.WindowAttachEvent) - */ - public void windowAttached(WindowAttachEvent event) { - Window win = event.getWindow(); - win.addListener((Paintable.RepaintRequestListener) this); - - // Add window to dirty window references if it is visible - // Or request the window to pass on the repaint requests - if (win.isVisible()) - addDirtyWindow(event.getApplication(), win); - else - win.requestRepaintRequests(); - - } - - /** - * @see com.itmill.toolkit.Application.WindowDetachListener#windowDetached(Application.WindowDetachEvent) - */ - public void windowDetached(WindowDetachEvent event) { - event.getWindow().removeListener( - (Paintable.RepaintRequestListener) this); - - // Adds dirty window reference for closing the window - addDirtyWindow(event.getApplication(), event.getWindow()); - } - - /** - * Receives repaint request events. - * - * @see com.itmill.toolkit.terminal.Paintable.RepaintRequestListener#repaintRequested(Paintable.RepaintRequestEvent) - */ - public void repaintRequested(RepaintRequestEvent event) { - - Paintable p = event.getPaintable(); - Application app = null; - if (p instanceof Window) - app = ((Window) p).getApplication(); - - if (app != null) - addDirtyWindow(app, ((Window) p)); - - Object lock = applicationToServerCommandStreamLock.get(app); - if (lock != null) - synchronized (lock) { - lock.notifyAll(); - } - } - - /** - * Gets the list of dirty windows in application. - * - * @param app - * @return - */ - protected Map getDirtyWindows(Application app) { - HashMap dirtyWindows; - synchronized (applicationToDirtyWindowSetMap) { - dirtyWindows = (HashMap) applicationToDirtyWindowSetMap.get(app); - } - return (Map) dirtyWindows; - } - - /** - * Removes a window from the list of dirty windows. - * - * @param app - * @param window - */ - private void windowPainted(Application app, Window window) { - removeDirtyWindow(app, window); - } - - /** - * Generates server commands stream. If the server commands are not - * requested, return false. - * - * @param request - * the HTTP request instance. - * @param response - * the HTTP response to write to. - */ - private boolean handleServerCommands(HttpServletRequest request, - HttpServletResponse response) { - - // Server commands are allways requested with certain parameter - if (request.getParameter(SERVER_COMMAND_PARAM) == null) - return false; - - // Gets the application - Application application; - try { - application = getApplication(request); - } catch (MalformedURLException e) { - return false; - } - if (application == null) - return false; - - // Creates continuous server commands stream - try { - - // Writer for writing the stream - PrintWriter w = new PrintWriter(response.getOutputStream()); - - // Prints necessary http page headers and padding - w.println("<html><head></head><body>"); - for (int i = 0; i < SERVER_COMMAND_HEADER_PADDING; i++) - w.print(' '); - - // Clock for synchronizing the stream - Object lock = new Object(); - synchronized (applicationToServerCommandStreamLock) { - Object oldlock = applicationToServerCommandStreamLock - .get(application); - if (oldlock != null) - synchronized (oldlock) { - oldlock.notifyAll(); - } - applicationToServerCommandStreamLock.put(application, lock); - } - while (applicationToServerCommandStreamLock.get(application) == lock - && application.isRunning()) { - synchronized (application) { - - // Session expiration - Date lastRequest; - synchronized (applicationToLastRequestDate) { - lastRequest = (Date) applicationToLastRequestDate - .get(application); - } - if (lastRequest != null - && lastRequest.getTime() - + request.getSession() - .getMaxInactiveInterval() * 1000 < System - .currentTimeMillis()) { - - // Session expired, close application - application.close(); - } else { - - // Application still alive - keep updating windows - Map dws = getDirtyWindows(application); - if (dws != null && !dws.isEmpty()) { - - // For one of the dirty windows (in each - // application) - // request redraw - Window win = (Window) dws.keySet().iterator() - .next(); - w - .println("<script>\n" - + ThemeFunctionLibrary - .getWindowRefreshScript( - application, - win, - WebBrowserProbe - .getTerminalType(request - .getSession())) - + "</script>"); - - removeDirtyWindow(application, win); - - // Windows that are closed immediately are "painted" - // now - if (win.getApplication() == null - || !win.isVisible()) - win.requestRepaintRequests(); - } - } - } - - // Sends the generated commands and newline immediately to - // browser - // TODO why space in here? why not plain ln? - w.println(" "); - w.flush(); - response.flushBuffer(); - - synchronized (lock) { - try { - lock.wait(SERVER_COMMAND_STREAM_MAINTAIN_PERIOD); - } catch (InterruptedException ignored) { - } - } - } - } catch (IOException ignore) { - - // In case of an Exceptions the server command stream is - // terminated - synchronized (applicationToServerCommandStreamLock) { - if (applicationToServerCommandStreamLock.get(application) == application) - applicationToServerCommandStreamLock.remove(application); - } - } - - return true; - } - - /** * * SessionBindingListener performs Application cleanups after sessions are * expired. For each session exists one SessionBindingListener. It contains @@ -2010,22 +1274,6 @@ public class ApplicationServlet extends HttpServlet implements // Close application ((Application) apps[i]).close(); - // Stops application server commands stream - Object lock = applicationToServerCommandStreamLock - .get(apps[i]); - if (lock != null) - synchronized (lock) { - lock.notifyAll(); - } - - // Remove application from hashmaps - synchronized (applicationToServerCommandStreamLock) { - applicationToServerCommandStreamLock - .remove(apps[i]); - } - synchronized (applicationToDirtyWindowSetMap) { - applicationToDirtyWindowSetMap.remove(apps[i]); - } synchronized (applicationToLastRequestDate) { applicationToLastRequestDate.remove(apps[i]); } @@ -2128,27 +1376,16 @@ public class ApplicationServlet extends HttpServlet implements * @param application * @return AJAX Application Manager */ - private AjaxApplicationManager getApplicationManager(Application application) { - AjaxApplicationManager mgr = (AjaxApplicationManager) applicationToAjaxAppMgrMap + private ApplicationManager getApplicationManager(Application application) { + ApplicationManager mgr = (ApplicationManager) applicationToAjaxAppMgrMap .get(application); // This application is going from Web to AJAX mode, create new manager if (mgr == null) { // Creates new manager - mgr = new AjaxApplicationManager(application); + mgr = new ApplicationManager(application, this); applicationToAjaxAppMgrMap.put(application, mgr); - // Stops sending changes to this servlet because manager will take - // control - application.removeListener((Application.WindowAttachListener) this); - application.removeListener((Application.WindowDetachListener) this); - - // Deregister all window listeners - for (Iterator wins = application.getWindows().iterator(); wins - .hasNext();) - ((Window) wins.next()) - .removeListener((Paintable.RepaintRequestListener) this); - // Manager takes control over the application mgr.takeControl(); } diff --git a/src/com/itmill/toolkit/terminal/web/HttpUploadStream.java b/src/com/itmill/toolkit/terminal/gwt/server/HttpUploadStream.java index deaeaeafec..b92fb9d451 100644 --- a/src/com/itmill/toolkit/terminal/web/HttpUploadStream.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/HttpUploadStream.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import java.io.InputStream; diff --git a/src/com/itmill/toolkit/terminal/web/HttpVariableMap.java b/src/com/itmill/toolkit/terminal/gwt/server/HttpVariableMap.java index a22d1a37f0..5fd4407971 100644 --- a/src/com/itmill/toolkit/terminal/web/HttpVariableMap.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/HttpVariableMap.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import com.itmill.toolkit.terminal.SystemError; import com.itmill.toolkit.terminal.Terminal; diff --git a/src/com/itmill/toolkit/terminal/gwt/server/JSONPaintTarget.java b/src/com/itmill/toolkit/terminal/gwt/server/JSONPaintTarget.java deleted file mode 100644 index a1a62918e9..0000000000 --- a/src/com/itmill/toolkit/terminal/gwt/server/JSONPaintTarget.java +++ /dev/null @@ -1,165 +0,0 @@ -package com.itmill.toolkit.terminal.gwt.server; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.Stack; - -import com.itmill.toolkit.Application; -import com.itmill.toolkit.terminal.ApplicationResource; -import com.itmill.toolkit.terminal.ExternalResource; -import com.itmill.toolkit.terminal.PaintException; -import com.itmill.toolkit.terminal.PaintTarget; -import com.itmill.toolkit.terminal.Paintable; -import com.itmill.toolkit.terminal.Resource; -import com.itmill.toolkit.terminal.ThemeResource; -import com.itmill.toolkit.terminal.VariableOwner; - -public class JSONPaintTarget implements PaintTarget { - - Stack tags = new Stack(); - Tag tag = null; - - public void addAttribute(String name, boolean value) throws PaintException { - tag.attrs.put(name, new Boolean(value)); - } - - public void addAttribute(String name, int value) throws PaintException { - tag.attrs.put(name, new Integer(value)); - } - - public void addAttribute(String name, Resource value) throws PaintException { - if (value instanceof ExternalResource) { - addAttribute(name, ((ExternalResource) value).getURL()); - - } else if (value instanceof ApplicationResource) { - ApplicationResource r = (ApplicationResource) value; - Application a = r.getApplication(); - if (a == null) - throw new PaintException( - "Application not specified for resorce " - + value.getClass().getName()); - String uri = a.getURL().getPath(); - if (uri.charAt(uri.length() - 1) != '/') - uri += "/"; - uri += a.getRelativeLocation(r); - addAttribute(name, uri); - - } else if (value instanceof ThemeResource) { - String uri = "theme://" + ((ThemeResource) value).getResourceId(); - addAttribute(name, uri); - } else - throw new PaintException("Ajax adapter does not " - + "support resources of type: " - + value.getClass().getName()); - } - - public void addAttribute(String name, long value) throws PaintException { - tag.attrs.put(name, new Long(value)); - } - - public void addAttribute(String name, String value) throws PaintException { - tag.attrs.put(name, value); - } - - public void addCharacterData(String text) throws PaintException { - if (tag.data != null || tag.xml != null || tag.children.size() > 0) - throw new IllegalStateException("Character data can not be combined with XML or child-nodes"); - tag.data = text; - } - - public void addSection(String sectionTagName, String sectionData) - throws PaintException { - Tag t = new Tag(sectionTagName); - t.data = sectionData; - if (tag.data != null || tag.xml != null) - throw new IllegalStateException("Children can not be combined with XML or chardata"); - tag.children.add(t); - } - - public void addText(String text) throws PaintException { - if (tag.data != null || tag.xml != null || tag.children.size() > 0) - throw new IllegalStateException("Text-data can not be combined with XML or child-nodes"); - tag.data = text; - } - - public void addUIDL(String uidl) throws PaintException { - if (tag.data != null || tag.xml != null || tag.children.size() > 0) - throw new IllegalStateException("XML can not be combined with text or child-nodes"); - tag.xml = uidl; - } - - public void addUploadStreamVariable(VariableOwner owner, String name) - throws PaintException { - // TODO Auto-generated method stub - - } - - public void addVariable(VariableOwner owner, String name, String value) - throws PaintException { - // TODO Auto-generated method stub - - } - - public void addVariable(VariableOwner owner, String name, int value) - throws PaintException { - // TODO Auto-generated method stub - - } - - public void addVariable(VariableOwner owner, String name, boolean value) - throws PaintException { - // TODO Auto-generated method stub - - } - - public void addVariable(VariableOwner owner, String name, String[] value) - throws PaintException { - // TODO Auto-generated method stub - - } - - public void addXMLSection(String sectionTagName, String sectionData, - String namespace) throws PaintException { - // TODO Auto-generated method stub - - } - - public void endTag(String tagName) throws PaintException { - - } - - public boolean startTag(Paintable paintable, String tag) - throws PaintException { - // TODO Auto-generated method stub - return false; - } - - public void startTag(String tagName) throws PaintException { - // TODO Auto-generated method stub - - } - - private class Tag { - HashMap attrs = new HashMap(); - - ArrayList children = new ArrayList(); - - ArrayList vars = new ArrayList(); - - String xml = null; - - String data = null; - - String tag; - - Tag(String tag) { - this.tag = tag; - } - } - - public void addAttribute(String string, Object[] keys) { - // TODO Auto-generated method stub - - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/AjaxJsonPaintTarget.java b/src/com/itmill/toolkit/terminal/gwt/server/JsonPaintTarget.java index 882dd8f140..6e4662e557 100644 --- a/src/com/itmill/toolkit/terminal/web/AjaxJsonPaintTarget.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/JsonPaintTarget.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import com.itmill.toolkit.Application; import com.itmill.toolkit.terminal.ApplicationResource; @@ -58,9 +58,9 @@ import java.util.Vector; * @author IT Mill Ltd. * @version * @VERSION@ - * @since 3.1 + * @since 5.0 */ -public class AjaxJsonPaintTarget implements PaintTarget, AjaxPaintTarget { +public class JsonPaintTarget implements PaintTarget { /* Document type declarations */ @@ -82,7 +82,7 @@ public class AjaxJsonPaintTarget implements PaintTarget, AjaxPaintTarget { private boolean closed = false; - private AjaxApplicationManager manager; + private ApplicationManager manager; private boolean trackPaints = false; @@ -106,8 +106,8 @@ public class AjaxJsonPaintTarget implements PaintTarget, AjaxPaintTarget { * @throws PaintException * if the paint operation failed. */ - public AjaxJsonPaintTarget(AjaxVariableMap variableMap, - AjaxApplicationManager manager, PrintWriter outWriter) + public JsonPaintTarget(AjaxVariableMap variableMap, + ApplicationManager manager, PrintWriter outWriter) throws PaintException { this.manager = manager; diff --git a/src/com/itmill/toolkit/terminal/web/Log.java b/src/com/itmill/toolkit/terminal/gwt/server/Log.java index ddc6ec2e3a..7a84341543 100644 --- a/src/com/itmill/toolkit/terminal/web/Log.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/Log.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; /** * <p> diff --git a/src/com/itmill/toolkit/terminal/web/MultipartRequest.java b/src/com/itmill/toolkit/terminal/gwt/server/MultipartRequest.java index 3b2620c6a5..ae22f5bbbb 100644 --- a/src/com/itmill/toolkit/terminal/web/MultipartRequest.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/MultipartRequest.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import java.util.Hashtable; import java.io.BufferedOutputStream; diff --git a/src/com/itmill/toolkit/terminal/web/ServletMultipartRequest.java b/src/com/itmill/toolkit/terminal/gwt/server/ServletMultipartRequest.java index 1980b0e92c..a0352e5944 100644 --- a/src/com/itmill/toolkit/terminal/web/ServletMultipartRequest.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/ServletMultipartRequest.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import java.io.IOException; diff --git a/src/com/itmill/toolkit/terminal/web/WebApplicationContext.java b/src/com/itmill/toolkit/terminal/gwt/server/WebApplicationContext.java index 09a1279995..0c53f87db6 100644 --- a/src/com/itmill/toolkit/terminal/web/WebApplicationContext.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/WebApplicationContext.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import java.io.File; import java.io.PrintWriter; diff --git a/src/com/itmill/toolkit/terminal/web/WebBrowser.java b/src/com/itmill/toolkit/terminal/gwt/server/WebBrowser.java index 93515291d2..f89db74c0a 100644 --- a/src/com/itmill/toolkit/terminal/web/WebBrowser.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/WebBrowser.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import com.itmill.toolkit.terminal.Terminal; @@ -105,8 +105,6 @@ public class WebBrowser implements Terminal { */ private int screenHeight = -1; - private RenderingMode renderingMode = RENDERING_MODE_UNDEFINED; - /** * Constuctor with some autorecognition capabilities Retrieves all * capability information reported in http request headers: @@ -702,41 +700,4 @@ public class WebBrowser implements Terminal { JAVASCRIPT_1_5, JSCRIPT_1_0, JSCRIPT_3_0, JSCRIPT_4_0, JSCRIPT_5_0, JSCRIPT_5_1, JSCRIPT_5_5, JSCRIPT_5_6, JSCRIPT_5_7, ECMA_262 }; - /* - * Consts defining the rendering mode @author IT Mill Ltd. - * - * @version @VERSION@ - * @since 4.0 - */ - public class RenderingMode { - RenderingMode() { - - } - } - - public static final RenderingMode RENDERING_MODE_UNDEFINED = DEFAULT.new RenderingMode(); - - public static final RenderingMode RENDERING_MODE_HTML = DEFAULT.new RenderingMode(); - - public static final RenderingMode RENDERING_MODE_AJAX = DEFAULT.new RenderingMode(); - - /** - * Gets the current rendering mode. - * - * @return the current rendering mode. - */ - public RenderingMode getRenderingMode() { - return renderingMode; - } - - /** - * Sets the current rendering mode. - * - * @param renderingMode - * the rendering mode. - */ - public void setRenderingMode(RenderingMode renderingMode) { - this.renderingMode = renderingMode; - } - } diff --git a/src/com/itmill/toolkit/terminal/web/WebBrowserProbe.java b/src/com/itmill/toolkit/terminal/gwt/server/WebBrowserProbe.java index 76bcd1f986..d6ca56c1b8 100644 --- a/src/com/itmill/toolkit/terminal/web/WebBrowserProbe.java +++ b/src/com/itmill/toolkit/terminal/gwt/server/WebBrowserProbe.java @@ -26,7 +26,7 @@ ********************************************************************** */ -package com.itmill.toolkit.terminal.web; +package com.itmill.toolkit.terminal.gwt.server; import java.util.Collection; import java.util.Enumeration; diff --git a/src/com/itmill/toolkit/terminal/web/AjaxPaintTarget.java b/src/com/itmill/toolkit/terminal/web/AjaxPaintTarget.java deleted file mode 100644 index 8db97e7dfb..0000000000 --- a/src/com/itmill/toolkit/terminal/web/AjaxPaintTarget.java +++ /dev/null @@ -1,59 +0,0 @@ -package com.itmill.toolkit.terminal.web; - -import java.util.Set; - -import com.itmill.toolkit.terminal.PaintException; -import com.itmill.toolkit.terminal.Paintable; -import com.itmill.toolkit.terminal.Resource; -import com.itmill.toolkit.terminal.VariableOwner; - -public interface AjaxPaintTarget { - - /** - * Gets the UIDL already printed to stream. Paint target must be closed - * before the <code>getUIDL</code> can be called. - * - * @return the UIDL. - */ - public abstract String getUIDL(); - - /** - * Closes the paint target. Paint target must be closed before the - * <code>getUIDL</code> can be called. Subsequent attempts to write to - * paint target. If the target was already closed, call to this function is - * ignored. will generate an exception. - * - * @throws PaintException - * if the paint operation failed. - */ - public abstract void close() throws PaintException; - - /** - * - * @return - */ - public abstract boolean isTrackPaints(); - - /** - * Gets the number of paints. - * - * @return the number of paints. - */ - public abstract int getNumberOfPaints(); - - /** - * Sets the tracking to true or false. - * - * This also resets the number of paints. - * - * @param enabled - * is the tracking is enabled or not. - * @see #getNumberOfPaints() - */ - public abstract void setTrackPaints(boolean enabled); - - public abstract void setPreCachedResources(Set preCachedResources); - - public abstract Set getPreCachedResources() ; - -}
\ No newline at end of file diff --git a/src/com/itmill/toolkit/terminal/web/AjaxXmlPaintTarget.java b/src/com/itmill/toolkit/terminal/web/AjaxXmlPaintTarget.java deleted file mode 100644 index dc175f731a..0000000000 --- a/src/com/itmill/toolkit/terminal/web/AjaxXmlPaintTarget.java +++ /dev/null @@ -1,608 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import com.itmill.toolkit.Application; -import com.itmill.toolkit.terminal.ApplicationResource; -import com.itmill.toolkit.terminal.ExternalResource; -import com.itmill.toolkit.terminal.PaintException; -import com.itmill.toolkit.terminal.PaintTarget; -import com.itmill.toolkit.terminal.Paintable; -import com.itmill.toolkit.terminal.Resource; -import com.itmill.toolkit.terminal.ThemeResource; -import com.itmill.toolkit.terminal.UploadStream; -import com.itmill.toolkit.terminal.VariableOwner; - -import java.io.BufferedWriter; -import java.io.OutputStream; -import java.io.OutputStreamWriter; -import java.io.PrintWriter; -import java.io.UnsupportedEncodingException; -import java.util.HashSet; -import java.util.Set; -import java.util.Stack; - -/** - * User Interface Description Language Target. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.1 - */ -public class AjaxXmlPaintTarget implements PaintTarget, AjaxPaintTarget { - - /* Document type declarations */ - private final static String UIDL_XML_DECL = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"; - - private final static String UIDL_ARG_NAME = "name"; - - private final static String UIDL_ARG_VALUE = "value"; - - private final static String UIDL_ARG_ID = "id"; - - private Stack mOpenTags; - - private boolean mTagArgumentListOpen; - - private PrintWriter uidlBuffer; - - private AjaxVariableMap variableMap; - - private boolean closed = false; - - private AjaxApplicationManager manager; - - private boolean trackPaints = false; - - private int numberOfPaints = 0; - - private Set preCachedResources = new HashSet(); - private boolean customLayoutArgumentsOpen = false; - - /** - * Creates a new XMLPrintWriter, without automatic line flushing. - * - * @param variableMap - * @param manager - * @param output - * A character-output stream. - * @throws PaintException - * if the paint operation failed. - */ - public AjaxXmlPaintTarget(AjaxVariableMap variableMap, - AjaxApplicationManager manager, OutputStream output) - throws PaintException { - - // Sets the cache - this.manager = manager; - - // Sets the variable map - this.variableMap = variableMap; - - // Sets the target for UIDL writing - try { - this.uidlBuffer = new PrintWriter(new BufferedWriter( - new OutputStreamWriter(output, "UTF-8"))); - } catch (UnsupportedEncodingException e) { - throw new RuntimeException("Internal error"); - } - - // Initialize tag-writing - mOpenTags = new Stack(); - mTagArgumentListOpen = false; - - // Adds document declaration - this.print(UIDL_XML_DECL + "\n\n"); - - // Adds UIDL start tag and its attributes - this.startTag("changes"); - - } - - /** - * Ensures that the currently open element tag is closed. - */ - private void ensureClosedTag() { - if (mTagArgumentListOpen) { - append(">"); - mTagArgumentListOpen = false; - customLayoutArgumentsOpen = false; - } - } - - /** - * Method append.This method is thread safe. - * - * @param string - * the text to insert. - */ - private void append(String string) { - uidlBuffer.print(string); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#startTag(java.lang.String) - */ - public void startTag(String tagName) throws PaintException { - // In case of null data output nothing: - if (tagName == null) - throw new NullPointerException(); - - // Increments paint tracker - if (this.isTrackPaints()) { - this.numberOfPaints++; - } - - // Ensures that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - // Makes sure that the open start tag is closed before - // anything is written. - ensureClosedTag(); - - // Checks tagName and attributes here - mOpenTags.push(tagName); - - // Prints the tag with attributes - append("<" + tagName); - - mTagArgumentListOpen = true; - - if ("customlayout".equals(tagName)) - customLayoutArgumentsOpen = true; - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#endTag(java.lang.String) - */ - public void endTag(String tagName) throws PaintException { - // In case of null data output nothing: - if (tagName == null) - throw new NullPointerException(); - - // Ensure that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - String lastTag = ""; - - lastTag = (String) mOpenTags.pop(); - if (!tagName.equalsIgnoreCase(lastTag)) - throw new PaintException("Invalid UIDL: wrong ending tag: '" - + tagName + "' expected: '" + lastTag + "'."); - - // Make sure that the open start tag is closed before - // anything is written. - if (mTagArgumentListOpen) { - append(">"); - mTagArgumentListOpen = false; - customLayoutArgumentsOpen = false; - } - - // Writes the end (closing) tag - append("</" + lastTag + ">"); - flush(); - } - - /** - * Substitutes the XML sensitive characters with predefined XML entities. - * - * @param xml - * the String to be substituted. - * @return A new string instance where all occurrences of XML sensitive - * characters are substituted with entities. - */ - static public String escapeXML(String xml) { - if (xml == null || xml.length() <= 0) - return ""; - return escapeXML(new StringBuffer(xml)).toString(); - } - - /** - * Substitutes the XML sensitive characters with predefined XML entities. - * - * @param xml - * the String to be substituted. - * @return A new StringBuffer instance where all occurrences of XML - * sensitive characters are substituted with entities. - * - */ - static public StringBuffer escapeXML(StringBuffer xml) { - if (xml == null || xml.length() <= 0) - return new StringBuffer(""); - - StringBuffer result = new StringBuffer(xml.length() * 2); - - for (int i = 0; i < xml.length(); i++) { - char c = xml.charAt(i); - String s = toXmlChar(c); - if (s != null) { - result.append(s); - } else { - result.append(c); - } - } - return result; - } - - /** - * Substitutes a XML sensitive character with predefined XML entity. - * - * @param c - * the Character to be replaced with an entity. - * @return String of the entity or null if character is not to be replaced - * with an entity. - */ - private static String toXmlChar(char c) { - switch (c) { - case '&': - return "&"; // & => & - case '>': - return ">"; // > => > - case '<': - return "<"; // < => < - case '"': - return """; // " => " - case '\'': - return "'"; // ' => ' - default: - return null; - } - } - - /** - * Prints XML. - * - * Writes pre-formatted XML to stream. Well-formness of XML is checked. - * - * <pre> - * - * TODO: XML checking should be made - * - * </pre> - * - * @param str - * the string to print. - */ - private void print(String str) { - // In case of null data output nothing: - if (str == null) - return; - - // Make sure that the open start tag is closed before - // anything is written. - ensureClosedTag(); - - // Write what was given - append(str); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addText(java.lang.String) - */ - public void addText(String str) throws PaintException { - addUIDL(escapeXML(str)); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addAttribute(java.lang.String, boolean) - */ - public void addAttribute(String name, boolean value) throws PaintException { - addAttribute(name, String.valueOf(value)); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addAttribute(java.lang.String, com.itmill.toolkit.terminal.Resource) - */ - public void addAttribute(String name, Resource value) throws PaintException { - - if (value instanceof ExternalResource) { - addAttribute(name, ((ExternalResource) value).getURL()); - - } else if (value instanceof ApplicationResource) { - ApplicationResource r = (ApplicationResource) value; - Application a = r.getApplication(); - if (a == null) - throw new PaintException( - "Application not specified for resorce " - + value.getClass().getName()); - String uri = a.getURL().getPath(); - if (uri.charAt(uri.length() - 1) != '/') - uri += "/"; - uri += a.getRelativeLocation(r); - addAttribute(name, uri); - - } else if (value instanceof ThemeResource) { - String uri = "theme://" + ((ThemeResource) value).getResourceId(); - addAttribute(name, uri); - } else - throw new PaintException("Ajax adapter does not " - + "support resources of type: " - + value.getClass().getName()); - - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addAttribute(java.lang.String, int) - */ - public void addAttribute(String name, int value) throws PaintException { - addAttribute(name, String.valueOf(value)); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addAttribute(java.lang.String, long) - */ - public void addAttribute(String name, long value) throws PaintException { - addAttribute(name, String.valueOf(value)); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addAttribute(java.lang.String, java.lang.String) - */ - public void addAttribute(String name, String value) throws PaintException { - // In case of null data output nothing: - if ((value == null) || (name == null)) - throw new NullPointerException( - "Parameters must be non-null strings"); - - // Ensure that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - // Check that argument list is writable. - if (!mTagArgumentListOpen) - throw new PaintException("XML argument list not open."); - - append(" " + name + "=\"" + escapeXML(value) + "\""); - - if (customLayoutArgumentsOpen && "style".equals(name)) - getPreCachedResources().add("layout/" + value + ".html"); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addVariable(com.itmill.toolkit.terminal.VariableOwner, java.lang.String, java.lang.String) - */ - public void addVariable(VariableOwner owner, String name, String value) - throws PaintException { - String code = variableMap.registerVariable(name, String.class, value, - owner); - startTag("string"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - addText(value); - endTag("string"); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addVariable(com.itmill.toolkit.terminal.VariableOwner, java.lang.String, int) - */ - public void addVariable(VariableOwner owner, String name, int value) - throws PaintException { - String code = variableMap.registerVariable(name, Integer.class, - new Integer(value), owner); - startTag("integer"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - addAttribute(UIDL_ARG_VALUE, String.valueOf(value)); - endTag("integer"); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addVariable(com.itmill.toolkit.terminal.VariableOwner, java.lang.String, boolean) - */ - public void addVariable(VariableOwner owner, String name, boolean value) - throws PaintException { - String code = variableMap.registerVariable(name, Boolean.class, - new Boolean(value), owner); - startTag("boolean"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - addAttribute(UIDL_ARG_VALUE, String.valueOf(value)); - endTag("boolean"); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addVariable(com.itmill.toolkit.terminal.VariableOwner, java.lang.String, java.lang.String[]) - */ - public void addVariable(VariableOwner owner, String name, String[] value) - throws PaintException { - String code = variableMap.registerVariable(name, String[].class, value, - owner); - startTag("array"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - for (int i = 0; i < value.length; i++) - addSection("ai", value[i]); - endTag("array"); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addUploadStreamVariable(com.itmill.toolkit.terminal.VariableOwner, java.lang.String) - */ - public void addUploadStreamVariable(VariableOwner owner, String name) - throws PaintException { - String code = variableMap.registerVariable(name, UploadStream.class, - null, owner); - startTag("uploadstream"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - endTag("uploadstream"); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addSection(java.lang.String, java.lang.String) - */ - public void addSection(String sectionTagName, String sectionData) - throws PaintException { - startTag(sectionTagName); - addText(sectionData); - endTag(sectionTagName); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addUIDL(java.lang.String) - */ - public void addUIDL(String xml) throws PaintException { - - // Ensure that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - // Make sure that the open start tag is closed before - // anything is written. - ensureClosedTag(); - - // Escape and write what was given - if (xml != null) - append(xml); - - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addXMLSection(java.lang.String, java.lang.String, java.lang.String) - */ - public void addXMLSection(String sectionTagName, String sectionData, - String namespace) throws PaintException { - - // Ensure that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - startTag(sectionTagName); - if (namespace != null) - addAttribute("xmlns", namespace); - append(">"); - mTagArgumentListOpen = false; - - if (sectionData != null) - append(sectionData); - endTag(sectionTagName); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#getUIDL() - */ - public String getUIDL() { - if (this.closed) { - return uidlBuffer.toString(); - } - throw new IllegalStateException( - "Tried to read UIDL from open PaintTarget"); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#close() - */ - public void close() throws PaintException { - if (!this.closed) { - this.endTag("changes"); - flush(); - - // Close all - this.uidlBuffer.close(); - this.closed = true; - } - } - - /** - * Method flush. - */ - private void flush() { - this.uidlBuffer.flush(); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#startTag(com.itmill.toolkit.terminal.Paintable, java.lang.String) - */ - public boolean startTag(Paintable paintable, String tag) - throws PaintException { - startTag(tag); - String id = manager.getPaintableId(paintable); - paintable.addListener(manager); - addAttribute("id", id); - return false; - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#addCharacterData(java.lang.String) - */ - public void addCharacterData(String text) throws PaintException { - ensureClosedTag(); - if (text != null) - append("<![CDATA[" + text + "]]>"); - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#isTrackPaints() - */ - public boolean isTrackPaints() { - return trackPaints; - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#getNumberOfPaints() - */ - public int getNumberOfPaints() { - return numberOfPaints; - } - - /* (non-Javadoc) - * @see com.itmill.toolkit.terminal.web.AjaxPaintTarget#setTrackPaints(boolean) - */ - public void setTrackPaints(boolean enabled) { - this.trackPaints = enabled; - this.numberOfPaints = 0; - } - - public void setPreCachedResources(Set preCachedResources) { - this.preCachedResources = preCachedResources; - } - - public Set getPreCachedResources() { - return preCachedResources; - } - - public void addAttribute(String string, String[] keys) { - // TODO Auto-generated method stub - - } - - public void addAttribute(String string, Object[] keys) { - // TODO Auto-generated method stub - - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/CollectionThemeSource.java b/src/com/itmill/toolkit/terminal/web/CollectionThemeSource.java deleted file mode 100644 index 047b787bf5..0000000000 --- a/src/com/itmill/toolkit/terminal/web/CollectionThemeSource.java +++ /dev/null @@ -1,210 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.io.InputStream; -import java.util.Collection; -import java.util.Iterator; -import java.util.LinkedList; -import java.util.List; - -/** - * Theme source for consisting of collection of other theme sources. This class - * is used to implement the retrieval of themes from multiple sources. Also this - * class implements the inheritance of themes by first retrieving the relevant - * parent theme information. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public class CollectionThemeSource implements ThemeSource { - - private List sources = new LinkedList(); - - /** - * Gets the name of the ThemeSource. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getName() - */ - public String getName() { - return "THEMES"; - } - - /** - * Gets the XSL stream for the specified theme and web-browser type. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getXSLStreams(Theme, - * WebBrowser) - */ - public Collection getXSLStreams(Theme theme, WebBrowser type) - throws ThemeException { - Collection xslFiles = new LinkedList(); - - // Adds parent theme XSL - xslFiles.addAll(this.getParentXSLStreams(theme, type)); - - // Adds theme XSL, Handle subdirectories: return the first match - for (Iterator i = this.sources.iterator(); i.hasNext();) { - ThemeSource source = (ThemeSource) i.next(); - if (source.getThemes().contains(theme)) - xslFiles.addAll(source.getXSLStreams(theme, type)); - } - - return xslFiles; - } - - /** - * - * @param theme - * @param type - * @return - * @throws ThemeException - * If the resource is not found or there was some problem - * finding the resource. - */ - private Collection getParentXSLStreams(Theme theme, WebBrowser type) - throws ThemeException { - Collection xslFiles = new LinkedList(); - String parentName = theme.getParent(); - if (parentName != null) { - Theme parent = this.getThemeByName(parentName); - if (parent != null) { - xslFiles.addAll(this.getXSLStreams(parent, type)); - } else { - throw new ThemeSource.ThemeException( - "Parent theme not found for name: " + parentName); - } - } - return xslFiles; - } - - /** - * Gets the last modification time, used to reload theme on changes. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getModificationTime() - */ - public long getModificationTime() { - long modTime = 0; - for (Iterator i = this.sources.iterator(); i.hasNext();) { - long t = ((ThemeSource) i.next()).getModificationTime(); - if (t > modTime) - modTime = t; - } - return modTime; - } - - /** - * Gets the input stream for the resource with the specified resource id. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getResource(String) - */ - public InputStream getResource(String resourceId) throws ThemeException { - - // Resolves theme name and resource name - int delim = resourceId.indexOf("/"); - String subResourceId = ""; - String themeName = ""; - if (delim >= 0 && delim < resourceId.length() - 1) { - subResourceId = resourceId.substring(delim + 1); - themeName = resourceId.substring(0, delim); - } - - // Gets the list of themes to look for the resource - List themes = new LinkedList(); - while (themeName != null && themeName.length() > 0) { - Theme t = this.getThemeByName(themeName); - if (t != null) - themes.add(themeName); - themeName = t.getParent(); - } - - // Iterate all themes in list - for (Iterator ti = themes.iterator(); ti.hasNext();) { - String name = (String) ti.next(); - String resource = name + "/" + subResourceId; - // Search all sources - for (Iterator i = this.sources.iterator(); i.hasNext();) { - try { - InputStream in = ((ThemeSource) i.next()) - .getResource(resource); - if (in != null) - return in; - } catch (ThemeException e) { - // Ignore and continue to next source - } - } - } - - throw new ThemeException("Theme resource not found:" + subResourceId - + " in themes " + themes); - } - - /** - * Gets the list of themes in the theme source. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getThemes() - */ - public Collection getThemes() { - Collection themes = new LinkedList(); - for (Iterator i = this.sources.iterator(); i.hasNext();) { - Collection c = ((ThemeSource) i.next()).getThemes(); - themes.addAll(c); - } - return themes; - } - - /** - * Gets the theme instance by name. - * - * @param name - * the theme name. - * @see com.itmill.toolkit.terminal.web.ThemeSource#getThemeByName(String) - */ - public Theme getThemeByName(String name) { - for (Iterator i = this.sources.iterator(); i.hasNext();) { - Theme t = ((ThemeSource) i.next()).getThemeByName(name); - if (t != null) - return t; - } - return null; - } - - /** - * Adds new theme source to this collection. - * - * @param source - * the Theme source to be added. - */ - public void add(ThemeSource source) { - this.sources.add(source); - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/DebugWindow.java b/src/com/itmill/toolkit/terminal/web/DebugWindow.java deleted file mode 100644 index 42d9f11fe5..0000000000 --- a/src/com/itmill/toolkit/terminal/web/DebugWindow.java +++ /dev/null @@ -1,446 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.io.BufferedWriter; -import java.io.File; -import java.io.FileNotFoundException; -import java.io.FileOutputStream; -import java.io.IOException; -import java.io.OutputStreamWriter; -import java.text.DateFormat; -import java.text.SimpleDateFormat; -import java.util.Collection; -import java.util.Date; -import java.util.HashMap; -import java.util.Iterator; -import java.util.LinkedList; - -import javax.servlet.http.HttpSession; - -import com.itmill.toolkit.Application; -import com.itmill.toolkit.data.util.BeanItem; -import com.itmill.toolkit.data.util.MethodProperty; -import com.itmill.toolkit.terminal.FileResource; -import com.itmill.toolkit.ui.*; - -/** - * This class provides a debugging window where one may view the UIDL of the - * current window, or in a tabset the UIDL of an active frameset. - * - * It is primarily intended for creating and debugging themes. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public class DebugWindow extends Window { - - protected static String WINDOW_NAME = "debug"; - - private Application debuggedApplication; - - private HashMap rawUIDL = new HashMap(); - - private ApplicationServlet servlet; - - private HttpSession session; - - private TabSheet tabs = new TabSheet(); - - private Select themeSelector; - - private Label applicationInfo = new Label("", Label.CONTENT_XHTML); - - /** - * Creates a new debug window for an application. - * - * @param debuggedApplication - * the Application to be debugged. - * @param session - * the Session to be debugged. - * @param servlet - * the Servlet to be debugged. - */ - protected DebugWindow(Application debuggedApplication, HttpSession session, - ApplicationServlet servlet) { - - super("Debug window"); - setName(WINDOW_NAME); - setServlet(servlet); - setSession(session); - setBorder(Window.BORDER_NONE); - - // Creates control buttons - OrderedLayout controls = new OrderedLayout( - OrderedLayout.ORIENTATION_HORIZONTAL); - controls.addComponent(new Button("Restart Application", this, - "restartApplication")); - controls - .addComponent(new Button("Clear Session", this, "clearSession")); - Collection themes = servlet.getThemeSource().getThemes(); - Collection names = new LinkedList(); - for (Iterator i = themes.iterator(); i.hasNext();) { - names.add(((Theme) i.next()).getName()); - } - - // Creates theme selector - themeSelector = new Select("Application Theme", names); - themeSelector.setWriteThrough(false); - - // Terminal type editor - Label terminal = new Label("<h2>Terminal Information</h2> ", - Label.CONTENT_XHTML); - Form browser = new Form(); - browser.setItemDataSource(new BeanItem(WebBrowserProbe - .getTerminalType(session))); - browser.removeItemProperty("class"); - browser.replaceWithSelect("javaScriptVersion", - WebBrowser.JAVASCRIPT_VERSIONS, WebBrowser.JAVASCRIPT_VERSIONS); - browser.replaceWithSelect("markupVersion", WebBrowser.MARKUP_VERSIONS, - WebBrowser.MARKUP_VERSIONS); - browser.setWriteThrough(false); - Button setbrowser = new Button("Set terminal information", browser, - "commit"); - setbrowser.dependsOn(browser); - - // Arrange the UI in tabsheet - TabSheet infoTabs = new TabSheet(); - addComponent(infoTabs); - - OrderedLayout appInfo = new OrderedLayout(); - infoTabs.addTab(appInfo, "Application", null); - appInfo.addComponent(applicationInfo); - appInfo.addComponent(controls); - appInfo.addComponent(themeSelector); - appInfo.addComponent(new Button("Change theme", this, "commitTheme")); - - OrderedLayout winInfo = new OrderedLayout(); - infoTabs.addTab(winInfo, "Windows", null); - winInfo.addComponent(tabs); - winInfo.addComponent(new Button("Save UIDL", this, "saveUIDL")); - - OrderedLayout termInfo = new OrderedLayout(); - infoTabs.addTab(termInfo, "Terminal", null); - termInfo.addComponent(terminal); - termInfo.addComponent(browser); - termInfo.addComponent(setbrowser); - - // Sets the debugged application - setDebuggedApplication(debuggedApplication); - - } - - /** - * - * @param caption - * @param keys - * @param names - * @return - */ - protected Select createSelect(String caption, Object[] keys, String[] names) { - Select s = new Select(caption); - s.addContainerProperty("name", String.class, ""); - for (int i = 0; i < keys.length; i++) { - s.addItem(keys[i]).getItemProperty("name").setValue(names[i]); - } - s.setItemCaptionPropertyId("name"); - return s; - } - - /** - * Saves the UIDL. - */ - public void saveUIDL() { - - synchronized (rawUIDL) { - - String currentUIDL = (String) rawUIDL.get(tabs.getSelectedTab()); - - if (currentUIDL == null) - return; - - DateFormat df = new SimpleDateFormat("yyyyMMdd-HHmmss"); - File file = new File("/uidl-debug" - + df.format(new Date(System.currentTimeMillis())) + ".xml"); - try { - BufferedWriter out = new BufferedWriter(new OutputStreamWriter( - new FileOutputStream(file))); - out.write(currentUIDL); - out.close(); - - // Open the UIDL also - open(new FileResource(file, this.getApplication())); - Log.info("UIDL written to file " + file); - } catch (FileNotFoundException e) { - Log.info("Failed to write debug to " + file + ": " + e); - } catch (IOException e) { - Log.info("Failed to write debug to " + file + ": " + e); - } - } - } - - /** - * Commits the theme. - * - */ - public void commitTheme() { - themeSelector.commit(); - } - - /** - * Clears the session. - */ - public void clearSession() { - session.invalidate(); - } - - /** - * Restarts the Application. - * - */ - public void restartApplication() { - if (debuggedApplication != null) - debuggedApplication.close(); - } - - /** - * - * @param window - * @param uidl - */ - protected void setWindowUIDL(Window window, String uidl) { - String caption = "UIDL:" + window.getName(); - synchronized (tabs) { - for (Iterator i = tabs.getComponentIterator(); i.hasNext();) { - Component c = (Component) i.next(); - if (tabs.getTabCaption(c).equals(caption)) { - ((Label) c).setValue(getHTMLFormattedUIDL(caption, uidl)); - ((Label) c).setContentMode(Label.CONTENT_XHTML); - rawUIDL.put(c, uidl); - caption = null; - } - } - - // Add new tab - if (caption != null) { - Label l = new Label(getHTMLFormattedUIDL(caption, uidl)); - l.setContentMode(Label.CONTENT_XHTML); - rawUIDL.put(l, uidl); - tabs.addTab(l, caption, null); - } - } - } - - /** - * - * @param caption - * @param uidl - * @return - */ - protected String getHTMLFormattedUIDL(String caption, String uidl) { - StringBuffer sb = new StringBuffer(); - - // Print formatted UIDL with errors embedded - // Perl5Util util = new Perl5Util(); - - int row = 0; - int prev = 0; - int index = 0; - boolean lastLineWasEmpty = false; - - sb - .append("<TABLE WIDTH=\"100%\" STYLE=\"border-left: 1px solid black; " - + "border-right: 1px solid black; border-bottom: " - + "1px solid black; border-top: 1px solid black\"" - + " cellpadding=\"0\" cellspacing=\"0\" BORDER=\"0\">"); - - if (caption != null) - sb.append("<TR><TH BGCOLOR=\"#ddddff\" COLSPAN=\"2\">" - + "<FONT SIZE=\"+2\">" + caption + "</FONT></TH></TR>\n"); - - boolean unfinished = true; - while (unfinished) { - row++; - - // Get individual line - index = uidl.indexOf('\n', prev); - String line; - if (index < 0) { - unfinished = false; - line = uidl.substring(prev); - } else { - line = uidl.substring(prev, index); - prev = index + 1; - } - - // Escape the XML - line = WebPaintTarget.escapeXML(line); - - // Code beautification : Comment lines - line = replaceAll(line, "<!--", - "<SPAN STYLE = \"color: #00dd00\"><!--"); - line = replaceAll(line, "-->", "--></SPAN>"); - - while (line.length() > 0 && line.charAt(0) == ' ') { - line = line.substring(1); - } - boolean isEmpty = (line.length() == 0 || line.equals("\r")); - line = " " + line; - - if (!(isEmpty && lastLineWasEmpty)) - sb - .append("<TR" - + ((row % 10) > 4 ? " BGCOLOR=\"#eeeeff\"" : "") - + ">" - + "<TD VALIGN=\"top\" ALIGN=\"rigth\" STYLE=\"border-right: 1px solid gray\"> " - + String.valueOf(row) + " </TD><TD>" + line - + "</TD></TR>\n"); - - lastLineWasEmpty = isEmpty; - - } - - sb.append("</TABLE>\n"); - - return sb.toString(); - } - - /** - * Replaces the characters in a substring of this <code>String</code> with - * characters in the specified <code>String</code>. The substring begins - * at the specified <code>start</code> and extends to the character at - * index <code>end - 1</code> or to the end of the <code>String</code> - * if no such character exists. - * <p> - * First the characters in the substring are removed and then the specified - * <code>String</code> is inserted at <code>start</code>. (The - * <code>StringBuffer</code> will be lengthened to accommodate the - * specified String if necessary.) - * </p> - * <p> - * NOTE: This operation is slow. - * </p> - * - * @param text - * @param start - * the beginning index, inclusive. - * @param end - * the ending index, exclusive. - * @param str - * the String that will replace previous contents. - * @return This string buffer. - */ - protected static String replace(String text, int start, int end, String str) { - return new StringBuffer(text).replace(start, end, str).toString(); - } - - /** - * - * @param text - * @param oldStr - * @param newStr - * @return - */ - protected static String replaceAll(String text, String oldStr, String newStr) { - StringBuffer sb = new StringBuffer(text); - - int newStrLen = newStr.length(); - int oldStrLen = oldStr.length(); - if (oldStrLen <= 0) - return text; - - int i = 0; - while (i <= sb.length() - oldStrLen) { - if (sb.substring(i, i + oldStrLen).equals(oldStr)) { - sb.replace(i, i + oldStrLen, newStr); - i += newStrLen; - } else { - i++; - } - } - return sb.toString(); - } - - /** - * Sets the application. - * - * @param application - * the application to set. - */ - protected void setDebuggedApplication(Application application) { - this.debuggedApplication = application; - if (application != null) { - applicationInfo.setValue("<h2>Application Class</h2> " - + application.getClass().getName()); - themeSelector.setPropertyDataSource(new MethodProperty(application, - "theme")); - } - } - - /** - * Returns the servlet. - * - * @return the WebAdapterServlet. - */ - protected ApplicationServlet getServlet() { - return servlet; - } - - /** - * Returns the session. - * - * @return the HttpSession. - */ - protected HttpSession getSession() { - return session; - } - - /** - * Sets the servlet. - * - * @param servlet - * the servlet to set. - */ - protected void setServlet(ApplicationServlet servlet) { - this.servlet = servlet; - } - - /** - * Sets the session. - * - * @param session - * the session to set. - */ - protected void setSession(HttpSession session) { - this.session = session; - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/DirectoryThemeSource.java b/src/com/itmill/toolkit/terminal/web/DirectoryThemeSource.java deleted file mode 100644 index 7130d4c6c3..0000000000 --- a/src/com/itmill/toolkit/terminal/web/DirectoryThemeSource.java +++ /dev/null @@ -1,312 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.io.File; -import java.io.FileInputStream; -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; -import java.util.Collection; -import java.util.Iterator; -import java.util.LinkedList; - -/** - * Theme source for reading themes from a directory on the Filesystem. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public class DirectoryThemeSource implements ThemeSource { - - private File path; - - private Theme theme; - - private ApplicationServlet webAdapterServlet; - - /** - * Collection of subdirectory entries. - */ - private Collection subdirs = new LinkedList(); - - /** - * Creates a new instance of ThemeRepository by reading the themes from a - * local directory. - * - * @param path - * the Path to the source directory . - * @param webAdapterServlet - * @throws ThemeException - * If the resource is not found or there was some problem - * finding the resource. - * @throws FileNotFoundException - * if no theme files are found. - * @throws IOException - * if the writing failed due to input/output error. - */ - public DirectoryThemeSource(File path, ApplicationServlet webAdapterServlet) - throws ThemeException, FileNotFoundException, IOException { - - this.path = path; - this.theme = null; - this.webAdapterServlet = webAdapterServlet; - - if (!this.path.isDirectory()) - throw new java.io.FileNotFoundException( - "Theme path must be a directory ('" + this.path + "')"); - - // Loads description file - File description = new File(path, Theme.DESCRIPTIONFILE); - if (description.exists()) { - try { - this.theme = new Theme(description); - } catch (Exception e) { - throw new ThemeException("ServletThemeSource: Failed to load '" - + path, e); - } - - // Debug info - if (webAdapterServlet.isDebugMode(null)) { - Log.info("Added DirectoryThemeSource: " + this.path); - } - - } else { - // There was no description file found. - // Handle subdirectories recursively - File[] files = this.path.listFiles(); - for (int i = 0; i < files.length; i++) { - if (files[i].isDirectory()) { - this.subdirs.add(new DirectoryThemeSource(files[i], - webAdapterServlet)); - } else if (files[i].getName().toLowerCase().endsWith(".jar")) { - this.subdirs.add(new JarThemeSource(files[i], - webAdapterServlet, "")); - } - } - - if (this.subdirs.isEmpty()) { - if (webAdapterServlet.isDebugMode(null)) { - Log - .debug("DirectoryThemeSource: Ignoring empty directory: " - + path); - } - } - } - } - - /** - * Gets the XSL stream for the specified theme and web-browser type. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getXSLStreams(Theme, - * WebBrowser) - */ - public Collection getXSLStreams(Theme theme, WebBrowser type) - throws ThemeException { - Collection xslFiles = new LinkedList(); - - // If this directory contains a theme - // return XSL from this theme - if (this.theme != null) { - - if (webAdapterServlet.isDebugMode(null)) { - Log.info("DirectoryThemeSource: Loading XSL from: " + theme); - } - - // Reloads the description file - File description = new File(path, Theme.DESCRIPTIONFILE); - if (description.exists()) { - try { - this.theme = new Theme(description); - } catch (IOException e) { - throw new ThemeException( - "Failed to reload theme description" + e); - } - } - - Collection fileNames = theme.getFileNames(type, Theme.MODE_HTML); - - // Adds all XSL file streams - for (Iterator i = fileNames.iterator(); i.hasNext();) { - File f = new File(this.path, (String) i.next()); - if (f.getName().endsWith(".xsl")) - try { - xslFiles.add(new XSLStream(f.getName(), - new FileInputStream(f))); - } catch (FileNotFoundException e) { - throw new ThemeException("XSL File not found: " + f); - } - } - - } else { - - // Handles subdirectories: return the first match - for (Iterator i = this.subdirs.iterator(); i.hasNext();) { - ThemeSource source = (ThemeSource) i.next(); - if (source.getThemes().contains(theme)) - xslFiles.addAll(source.getXSLStreams(theme, type)); - } - } - - // Returns the concatenated stream - return xslFiles; - - } - - /** - * Gets the last modification time, used to reload theme on changes. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getModificationTime() - */ - public long getModificationTime() { - - long modTime = 0; - - // If this directory contains a theme - // returns XSL from this theme - if (this.theme != null) { - - // Gets modification time of the description file - modTime = new File(this.path, Theme.DESCRIPTIONFILE).lastModified(); - - // Gets modification time of the themes directory itself - if (this.path.lastModified() > modTime) { - modTime = this.path.lastModified(); - } - - // Check modification time for all files - Collection fileNames = theme.getFileNames(); - for (Iterator i = fileNames.iterator(); i.hasNext();) { - File f = new File(this.path, (String) i.next()); - if (f.lastModified() > modTime) { - modTime = f.lastModified(); - } - } - } else { - // Handles subdirectories - for (Iterator i = this.subdirs.iterator(); i.hasNext();) { - ThemeSource source = (ThemeSource) i.next(); - long t = source.getModificationTime(); - if (t > modTime) - modTime = t; - } - } - - return modTime; - - } - - /** - * Gets the input stream for the resource with the specified resource id. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getResource(String) - */ - public InputStream getResource(String resourceId) - throws ThemeSource.ThemeException { - - // If this directory contains a theme - // return resource from this theme - if (this.theme != null) { - - try { - return new FileInputStream(new File(this.path, resourceId)); - } catch (FileNotFoundException e) { - throw new ThemeSource.ThemeException("Resource " + resourceId - + " not found."); - } - - } else { - int delim = resourceId.indexOf("/"); - String subResourceName = ""; - if (delim < resourceId.length() - 1) - subResourceName = resourceId.substring(delim + 1); - String subSourceName = resourceId.substring(0, delim); - for (Iterator i = this.subdirs.iterator(); i.hasNext();) { - ThemeSource source = (ThemeSource) i.next(); - if (source.getName().equals(subSourceName)) { - return source.getResource(subResourceName); - } - } - } - - throw new ThemeSource.ThemeException("Resource " + resourceId - + " not found."); - - } - - /** - * Gets the list of themes in the theme source. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getThemes() - */ - public Collection getThemes() { - Collection themes = new LinkedList(); - if (this.theme != null) { - themes.add(this.theme); - } else { - for (Iterator i = this.subdirs.iterator(); i.hasNext();) { - ThemeSource source = (ThemeSource) i.next(); - themes.addAll(source.getThemes()); - } - - } - return themes; - } - - /** - * Gets the name of the ThemeSource. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getName() - */ - public String getName() { - if (this.theme != null) { - return this.theme.getName(); - } else { - return this.path.getName(); - } - } - - /** - * Gets the Theme instance by name. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getThemeByName(String) - */ - public Theme getThemeByName(String name) { - Collection themes = this.getThemes(); - for (Iterator i = themes.iterator(); i.hasNext();) { - Theme t = (Theme) i.next(); - if (name != null && name.equals(t.getName())) - return t; - } - return null; - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/JarThemeSource.java b/src/com/itmill/toolkit/terminal/web/JarThemeSource.java deleted file mode 100644 index 2761f795ff..0000000000 --- a/src/com/itmill/toolkit/terminal/web/JarThemeSource.java +++ /dev/null @@ -1,406 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.File; -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; -import java.lang.ref.SoftReference; -import java.util.Collection; -import java.util.Enumeration; -import java.util.HashMap; -import java.util.Iterator; -import java.util.LinkedList; -import java.util.Map; -import java.util.jar.JarEntry; -import java.util.jar.JarFile; - -/** - * Theme source for reading themes from a JAR archive. At this time only jar - * files are supported and an archive may not contain any recursive archives. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public class JarThemeSource implements ThemeSource { - - private File file; - - private JarFile jar; - - private Theme theme; - - private String path; - - private String name; - - private ApplicationServlet webAdapterServlet; - - private Cache resourceCache = new Cache(); - - /** - * Collection of subdirectory entries. - */ - private Collection subdirs = new LinkedList(); - - /** - * Creates a new instance of ThemeRepository by reading the themes from a - * local directory. - * - * @param file - * the Path to the JAR archive . - * @param webAdapterServlet - * @param path - * the Path inside the archive to be processed. - * @throws ThemeException - * If the resource is not found or there was some problem - * finding the resource. - * - * @throws FileNotFoundException - * if no theme files are found. - * @throws IOException - * if the writing failed due to input/output error. - */ - public JarThemeSource(File file, ApplicationServlet webAdapterServlet, - String path) throws ThemeException, FileNotFoundException, - IOException { - - this.file = file; - this.jar = new JarFile(file); - this.theme = null; - this.path = path; - if (this.path.length() > 0 && !this.path.endsWith("/")) { - this.path = this.path + "/"; - } - this.name = file.getName(); - if (this.name.toLowerCase().endsWith(".jar")) { - this.name = this.name.substring(0, this.name.length() - 4); - } - - this.webAdapterServlet = webAdapterServlet; - - // Loads description file - JarEntry entry = jar.getJarEntry(this.path + Theme.DESCRIPTIONFILE); - if (entry != null) { - try { - this.theme = new Theme(jar.getInputStream(entry)); - } catch (Exception e) { - throw new ThemeException("JarThemeSource: Failed to load '" - + path + "': ", e); - } - - // Debug info - if (webAdapterServlet.isDebugMode(null)) { - Log.debug("Added JarThemeSource: " + this.file + ":" - + this.path); - } - - } else { - // There was no description file found. - // Handle subdirectories recursively - for (Enumeration entries = jar.entries(); entries.hasMoreElements();) { - JarEntry e = (JarEntry) entries.nextElement(); - if (e.getName().startsWith(this.path)) { - if (e.getName().endsWith("/") - && e.getName().indexOf('/', this.path.length()) == (e - .getName().length() - 1)) { - this.subdirs.add(new JarThemeSource(this.file, - this.webAdapterServlet, e.getName())); - } - } - } - - if (this.subdirs.isEmpty()) { - if (webAdapterServlet.isDebugMode(null)) { - Log.info("JarThemeSource: Ignoring empty JAR path: " - + this.file + " path: " + this.path); - } - } - } - } - - /** - * Gets the XSL stream for the specified theme and web-browser type. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getXSLStreams(Theme, - * WebBrowser) - */ - public Collection getXSLStreams(Theme theme, WebBrowser type) - throws ThemeException { - Collection xslFiles = new LinkedList(); - // If this directory contains a theme - // return XSL from this theme - if (this.theme != null) { - - if (webAdapterServlet.isDebugMode(null)) { - Log.info("JarThemeSource: Loading XSL from: " + theme); - } - - // Reload the theme if JAR has been modified - JarEntry entry = jar.getJarEntry(this.path + Theme.DESCRIPTIONFILE); - if (entry != null) { - try { - this.theme = new Theme(jar.getInputStream(entry)); - } catch (IOException e) { - throw new ThemeException("Failed to read description: " - + this.file + ":" + this.path - + Theme.DESCRIPTIONFILE); - } - } - - Collection fileNames = theme.getFileNames(type, Theme.MODE_HTML); - // Add all XSL file streams - for (Iterator i = fileNames.iterator(); i.hasNext();) { - entry = jar.getJarEntry(this.path + (String) i.next()); - if (entry.getName().endsWith(".xsl")) - try { - xslFiles.add(new XSLStream(entry.getName(), jar - .getInputStream(entry))); - } catch (java.io.FileNotFoundException e) { - throw new ThemeException("XSL File not found: " - + this.file + ": " + entry); - } catch (java.io.IOException e) { - throw new ThemeException("Failed to read XSL file. " - + this.file + ": " + entry); - } - } - - } else { - - // Handle subdirectories in archive: return the first match - for (Iterator i = this.subdirs.iterator(); i.hasNext();) { - ThemeSource source = (ThemeSource) i.next(); - if (source.getThemes().contains(theme)) - xslFiles.addAll(source.getXSLStreams(theme, type)); - } - } - - return xslFiles; - } - - /** - * Returns modication time of the jar file. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getModificationTime() - */ - public long getModificationTime() { - return this.file.lastModified(); - } - - /** - * Gets the input stream for the resource with the specified resource id. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getResource(String) - */ - public InputStream getResource(String resourceId) - throws ThemeSource.ThemeException { - - // Strip off the theme name prefix from resource id - if (this.theme != null && this.theme.getName() != null - && resourceId.startsWith(this.theme.getName() + "/")) { - resourceId = resourceId - .substring(this.theme.getName().length() + 1); - } - - // Returns the resource inside the jar file - JarEntry entry = jar.getJarEntry(resourceId); - if (entry != null) - try { - - // Try cache - byte[] data = (byte[]) resourceCache.get(entry); - if (data != null) - return new ByteArrayInputStream(data); - - // Reads data - int bufSize = 1024; - ByteArrayOutputStream out = new ByteArrayOutputStream(bufSize); - InputStream in = jar.getInputStream(entry); - byte[] buf = new byte[bufSize]; - int n = 0; - while ((n = in.read(buf)) >= 0) { - out.write(buf, 0, n); - } - in.close(); - data = out.toByteArray(); - - // Cache data - resourceCache.put(entry, data); - return new ByteArrayInputStream(data); - } catch (IOException e) { - } - - throw new ThemeSource.ThemeException("Resource " + resourceId - + " not found."); - } - - /** - * Gets the list of themes in the theme source. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getThemes() - */ - public Collection getThemes() { - Collection themes = new LinkedList(); - if (this.theme != null) { - themes.add(this.theme); - } else { - for (Iterator i = this.subdirs.iterator(); i.hasNext();) { - ThemeSource source = (ThemeSource) i.next(); - themes.addAll(source.getThemes()); - } - } - return themes; - } - - /** - * Gets the name of the ThemeSource. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getName() - */ - public String getName() { - if (this.theme != null) { - return this.theme.getName(); - } else { - return this.name; - } - } - - /** - * Gets the Theme instance by name. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getThemeByName(String) - */ - public Theme getThemeByName(String name) { - Collection themes = this.getThemes(); - for (Iterator i = themes.iterator(); i.hasNext();) { - Theme t = (Theme) i.next(); - if (name != null && name.equals(t.getName())) - return t; - } - return null; - } - - /** - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - private class Cache { - - private Map data = new HashMap(); - - /** - * Associates the specified value with the specified key in this map. If - * the map previously contained a mapping for this key, the old value is - * replaced by the specified value. - * - * @param key - * the key with which the specified value is to be - * associated. - * @param value - * the value to be associated with the specified key. - */ - public void put(Object key, Object value) { - data.put(key, new SoftReference(new CacheItem(value))); - } - - /** - * Returns the value to which this map maps the specified key. Returns - * null if the map contains no mapping for this key. - * <p> - * A return value of null does not necessarily indicate that the map - * contains no mapping for the key; it's also possible that the map - * explicitly maps the key to null. The containsKey operation may be - * used to distinguish these two cases. - * </p> - * - * @param key - * the key whose associated value is to be returned. - * @return the value to which this map maps the specified key, or null - * if the map contains no mapping for this key. - */ - public Object get(Object key) { - SoftReference ref = (SoftReference) data.get(key); - if (ref != null) - return ((CacheItem) ref.get()).getData(); - return null; - } - - /** - * Clears the data. - * - */ - public void clear() { - data.clear(); - } - } - - /** - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - private class CacheItem { - - private Object data; - - /** - * - * @param data - */ - public CacheItem(Object data) { - this.data = data; - } - - /** - * - * @return - */ - public Object getData() { - return this.data; - }; - - /** - * @see java.lang.Object#finalize() - */ - public void finalize() throws Throwable { - this.data = null; - super.finalize(); - } - - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/ServletThemeSource.java b/src/com/itmill/toolkit/terminal/web/ServletThemeSource.java deleted file mode 100644 index 8221d04ab7..0000000000 --- a/src/com/itmill/toolkit/terminal/web/ServletThemeSource.java +++ /dev/null @@ -1,392 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.InputStream; -import java.lang.ref.SoftReference; -import java.net.URL; -import java.net.URLConnection; -import java.util.Collection; -import java.util.HashMap; -import java.util.Iterator; -import java.util.LinkedList; -import java.util.Map; - -import javax.servlet.ServletContext; - -/** - * Theme source for reading themes from a JAR archive. At this time only jar - * files are supported and an archive may not contain any recursive archives. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public class ServletThemeSource implements ThemeSource { - - private ServletContext context; - - private Theme theme; - - private String path; - - private ApplicationServlet webAdapterServlet; - - private Cache resourceCache = new Cache(); - - /** - * Collection of subdirectory entries. - */ - private URL descFile; - - /** - * Creates a new instance of ThemeRepository by reading the themes from a - * local directory. - * - * @param file - * the Path to the JAR archive . - * @param path - * the Path inside the archive to be processed. - * @throws IOException - * if the writing failed due to input/output error. - * @throws ThemeException - * If the resource is not found or there was some problem - * finding the resource. - */ - public ServletThemeSource(ServletContext context, - ApplicationServlet webAdapterServlet, String path) - throws IOException, ThemeException { - - this.theme = null; - this.webAdapterServlet = webAdapterServlet; - this.context = context; - - // Formats path - this.path = path; - if ((this.path.length() > 0) && !this.path.endsWith("/")) { - this.path = this.path + "/"; - } - if ((this.path.length() > 0) && !this.path.startsWith("/")) { - this.path = "/" + this.path; - } - - // Loads description file - this.descFile = context.getResource(this.path + Theme.DESCRIPTIONFILE); - InputStream entry = context.getResourceAsStream(this.path - + Theme.DESCRIPTIONFILE); - try { - if (entry != null) { - try { - this.theme = new Theme(entry); - } catch (Exception e) { - throw new ThemeException( - "ServletThemeSource: Failed to load '" + path - + "': " + e); - } - entry.close(); - - // Debug info - if (webAdapterServlet.isDebugMode(null)) { - Log.debug("Added ServletThemeSource: " + this.path); - } - - } else { - throw new IllegalArgumentException( - "ServletThemeSource: Invalid theme resource: " + path); - } - } finally { - if (entry != null) - entry.close(); - } - } - - /** - * Gets the XSL stream for the specified theme and web-browser type. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getXSLStreams(Theme, - * WebBrowser) - */ - public Collection getXSLStreams(Theme theme, WebBrowser type) - throws ThemeException { - Collection xslFiles = new LinkedList(); - - // If this directory contains a theme - // return XSL from this theme - if (this.theme != null) { - - if (webAdapterServlet.isDebugMode(null)) { - Log.info("ServletThemeSource: Loading theme: " + theme); - } - - // Reloads the description file - InputStream entry = context.getResourceAsStream(this.path - + Theme.DESCRIPTIONFILE); - try { - if (entry != null) { - this.theme = new Theme(entry); - } - } catch (Exception e) { - throw new ThemeException("ServletThemeSource: Failed to load '" - + path + "': " + e); - } finally { - if (entry != null) - try { - entry.close(); - } catch (IOException ignored) { - } - } - - Collection fileNames = theme.getFileNames(type, Theme.MODE_HTML); - // Adds all XSL file streams - for (Iterator i = fileNames.iterator(); i.hasNext();) { - String entryName = (String) i.next(); - if (entryName.endsWith(".xsl")) { - - entry = context - .getResourceAsStream((this.path + entryName)); - xslFiles.add(new XSLStream(entryName, entry)); - } - } - - } - return xslFiles; - } - - /** - * Returns the modification time of the description file. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getModificationTime() - */ - public long getModificationTime() { - long modTime = 0; - try { - URLConnection conn = this.descFile.openConnection(); - modTime = conn.getLastModified(); - } catch (Exception ignored) { - // In case of exceptions, return zero - } - return modTime; - } - - /** - * Gets the input stream for the resource with the specified resource id. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getResource(String) - */ - public InputStream getResource(String resourceId) - throws ThemeSource.ThemeException { - - // Checks the id - String name = this.getName(); - int namelen = name.length(); - if (resourceId == null || !resourceId.startsWith(name + "/") - || resourceId.length() <= (namelen + 1)) { - return null; - } - - // Finds the resource - String streamName = this.path + resourceId.substring(namelen + 1); - InputStream stream = context.getResourceAsStream(streamName); - if (stream != null) - try { - - // Try cache - byte[] data = (byte[]) resourceCache.get(stream); - if (data != null) - return new ByteArrayInputStream(data); - - // Read data - int bufSize = 1024; - ByteArrayOutputStream out = new ByteArrayOutputStream(bufSize); - byte[] buf = new byte[bufSize]; - int n = 0; - while ((n = stream.read(buf)) >= 0) { - out.write(buf, 0, n); - } - try { - stream.close(); - } catch (IOException ignored) { - } - data = out.toByteArray(); - - // Cache data - resourceCache.put(stream, data); - return new ByteArrayInputStream(data); - } catch (IOException e) { - } - - throw new ThemeSource.ThemeException("Resource " + resourceId - + " not found."); - } - - /** - * Gets the list of themes in the theme source. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getThemes() - */ - public Collection getThemes() { - Collection themes = new LinkedList(); - if (this.theme != null) { - themes.add(this.theme); - } - return themes; - } - - /** - * Gets the name of the ThemeSource. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getName() - */ - public String getName() { - return this.theme.getName(); - } - - /** - * Gets the Theme instance by name. - * - * @see com.itmill.toolkit.terminal.web.ThemeSource#getThemeByName(String) - */ - public Theme getThemeByName(String name) { - Collection themes = this.getThemes(); - for (Iterator i = themes.iterator(); i.hasNext();) { - Theme t = (Theme) i.next(); - if (name != null && name.equals(t.getName())) - return t; - } - return null; - } - - /** - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - private class Cache { - - private Map data = new HashMap(); - - /** - * Associates the specified value with the specified key in this map. If - * the map previously contained a mapping for this key, the old value is - * replaced by the specified value. - * - * @param key - * the key with which the specified value is to be - * associated. - * @param value - * the value to be associated with the specified key. - */ - public void put(Object key, Object value) { - data.put(key, new SoftReference(new CacheItem(value))); - } - - /** - * Returns the value to which this map maps the specified key. Returns - * null if the map contains no mapping for this key. - * <p> - * A return value of null does not necessarily indicate that the map - * contains no mapping for the key; it's also possible that the map - * explicitly maps the key to null. The containsKey operation may be - * used to distinguish these two cases. - * </p> - * - * @param key - * the key whose associated value is to be returned. - * @return the value to which this map maps the specified key, or null - * if the map contains no mapping for this key. - */ - public Object get(Object key) { - SoftReference ref = (SoftReference) data.get(key); - if (ref != null) - return ((CacheItem) ref.get()).getData(); - return null; - } - - /** - * Clears the data and removes all mappings from this map . - */ - public void clear() { - data.clear(); - } - } - - /** - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - private class CacheItem { - - private Object data; - - /** - * - * @param data - */ - public CacheItem(Object data) { - this.data = data; - } - - /** - * Gets the data. - * - * @return the data. - */ - public Object getData() { - return this.data; - }; - - /** - * Called by the garbage collector on an object when garbage collection - * determines that there are no more references to the object. A - * subclass overrides the finalize method to dispose of system resources - * or to perform other cleanup. - * <p> - * The finalize method is never invoked more than once by a Java virtual - * machine for any given object. - * </p> - * - * @throws Throwable - * the Exception raised by this method - * @see java.lang.Object#finalize() - */ - public void finalize() throws Throwable { - this.data = null; - super.finalize(); - } - - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/TO BE DEPRECATED FROM 5.0 b/src/com/itmill/toolkit/terminal/web/TO BE DEPRECATED FROM 5.0 deleted file mode 100644 index 6a4a7bc868..0000000000 --- a/src/com/itmill/toolkit/terminal/web/TO BE DEPRECATED FROM 5.0 +++ /dev/null @@ -1,5 +0,0 @@ - -We'll selectively copy resources from "web/ajax-adapter" to gwt and deprecate web from 4.0 - -Although this directory will probably be deleted in future, please DO NOT YET delete resource from -this directory
\ No newline at end of file diff --git a/src/com/itmill/toolkit/terminal/web/Theme.java b/src/com/itmill/toolkit/terminal/web/Theme.java deleted file mode 100644 index dbc879e7b4..0000000000 --- a/src/com/itmill/toolkit/terminal/web/Theme.java +++ /dev/null @@ -1,1243 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.io.FileInputStream; -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; -import java.util.Collection; -import java.util.LinkedHashMap; -import java.util.Iterator; -import java.util.LinkedList; -import java.util.List; -import java.util.Stack; -import javax.xml.parsers.ParserConfigurationException; -import javax.xml.parsers.SAXParserFactory; -import org.xml.sax.helpers.DefaultHandler; -import org.xml.sax.SAXException; -import org.xml.sax.InputSource; -import org.xml.sax.XMLReader; -import org.xml.sax.Attributes; - -/** - * This class provides an interface to the meta-information regarding a - * particular theme. This entails for instanace the inheritance tree of the - * various xsl-template files, the different requirments that the theme imposes - * on the client browser, etc. - * <p> - * The WebAdapter uses themes to convert the UIDL description into client - * representation, typically HTML or XHTML. A theme consists of set of XSL - * template files which are used to perform XSL transform. - * </p> - * <p> - * XSL files are divided into sets, which can have requirements. A file set is - * included in transformation only if the given requirements are met. Following - * requirements are supported: - * <ul> - * <li>User-Agent HTTP header substring matching</li> - * <li>Markup language version</li> - * <li>JavaScript version</li> - * </ul> - * Additionally following boolean operators may be applied to above - * requirements: - * <ul> - * <li>NOT</li> - * <li>AND</li> - * <li>OR</li> - * </ul> - * The requirements are introduced in XML description file. See example below. - * </p> - * <p> - * The theme description is XML data, and it can be loaded from file or stream. - * The default filename is specified by <code>Theme.DESCRIPTIONFILE</code>. - * - * </p> - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public class Theme extends DefaultHandler { - - /** - * Default description file name. - */ - public static final String DESCRIPTIONFILE = "description.xml"; - - private static final String TAG_THEME = "theme"; - - private static final String TAG_EXTENDS = "extends"; - - private static final String TAG_DESCRIPTION = "description"; - - private static final String TAG_FILE = "file"; - - private static final String TAG_FILESET = "fileset"; - - private static final String TAG_MODE = "mode"; - - private static final String TAG_MODES = "modes"; - - private static final String TAG_REQUIRE = "require"; - - private static final String TAG_SUPPORTS = "supports"; - - private static final String TAG_AUTHOR = "author"; - - private static final String TAG_AND = "and"; - - private static final String TAG_OR = "or"; - - private static final String TAG_NOT = "not"; - - private static final String ATTR_NAME = "name"; - - private static final String ATTR_THEME = "theme"; - - private static final String ATTR_EMAIL = "email"; - - private static final String ATTR_MODE = "mode"; - - private static final String ATTR_JAVASCRIPT = "javascript"; - - private static final String ATTR_AGENT = "agent"; - - private static final String ATTR_MARKUP = "markup"; - - public static final String MODE_AJAX = "ajax"; - - public static final String MODE_HTML = "html"; - - public static final String MODE_FALLBACK = MODE_HTML; - - public static final String MESSAGE_CONFIGURE_HELP = "You can provide themes by adding " - + "itmill-toolkit-x.y.z-themes.jar " - + "to WEB-INF/lib directory or adding " - + "theme files under WEB-INF/lib/themes directory." - + " Check also theme's description.xml."; - - /** - * Name of the theme. - */ - private String name; - - /** - * Theme description. - */ - private String description; - - /** - * Author of the theme. - */ - private Author author; - - /** - * Name of the theme, which this theme extends. - */ - private String parentTheme = null; - - /** - * Fileset of included XSL files. - */ - private Fileset files = null; - - /** - * Stack of fileset used while parsing XML. - */ - private Stack openFilesets = new Stack(); - - /** - * Stack of string buffers used while parsing XML. - */ - private Stack openStrings = new Stack(); - - /** - * Supported modes name-to-requirements. - */ - private LinkedHashMap supportedModes = new LinkedHashMap(); - - /** - * Currently open mode. - */ - private String currentlyOpenMode = null; - - /** - * Are we processing modes. - */ - private boolean modesListCurrentlyOpen = false; - - /** - * Is a NOT requirement element open. - */ - private boolean isNOTRequirementOpen = false; - - /** - * Currently open requirements while parsing. - */ - private Stack openRequirements = new Stack(); - - /** - * Creates a new instance using XML description file. Instantiate new theme, - * by loading the description from given File. - * - * @param descriptionFile - * the Description file. - * @throws FileNotFoundException - * Thrown if the given file is not found. - */ - public Theme(java.io.File descriptionFile) throws FileNotFoundException { - parse(new InputSource(new FileInputStream(descriptionFile))); - } - - /** - * Creates a new instance using XML description stream. Instantiate new - * theme, by loading the description from given InputSource. - * - * @param descriptionStream - * the XML input to parse - */ - public Theme(InputStream descriptionStream) { - try { - parse(new InputSource(descriptionStream)); - } finally { - try { - descriptionStream.close(); - } catch (IOException ignored) { - } - } - } - - /** - * Gets the preferred operating mode supported by this theme for given - * terminal. - * - * @param terminal - * the type of the web browser. - * @param themeSource - */ - public String getPreferredMode(WebBrowser terminal, ThemeSource themeSource) { - - // If no supported modes are declared, then we use parents preferred - // mode - if (parentTheme != null && supportedModes.keySet().isEmpty()) { - Theme parent = themeSource.getThemeByName(parentTheme); - if (parent == null) - throw new IllegalStateException("Parent theme '" + parentTheme - + "' is not found for theme '" + getName() + "'."); - return parent.getPreferredMode(terminal, themeSource); - } - - // Iterate and test the modes in order - for (Iterator i = supportedModes.keySet().iterator(); i.hasNext();) { - String mode = (String) i.next(); - if (supportsMode(mode, terminal, themeSource)) - return mode; - } - - return null; - } - - /** - * Tests if this theme suppors given mode. - * - * @param mode - * @param terminal - * the type of the web browser. - * @param themeSource - */ - public boolean supportsMode(String mode, WebBrowser terminal, - ThemeSource themeSource) { - - // Theme must explicitly support the given mode - RequirementCollection rc = (RequirementCollection) supportedModes - .get(mode); - - if (rc == null || !rc.isMet(terminal)) - return false; - - // All parents must also support the mode - if (parentTheme != null) { - Theme parent = themeSource.getThemeByName(parentTheme); - if (parent == null) - throw new IllegalStateException("Parent theme '" + parentTheme - + "' is not found for theme '" + getName() + "'. " - + MESSAGE_CONFIGURE_HELP); - if (!parent.supportsMode(mode, terminal, themeSource)) - return false; - } - - return true; - } - - /** - * Parses the XML data. - * - * @param descriptionSource - * the XML input source to parse. - */ - private synchronized void parse(InputSource descriptionSource) { - - // Clean-up parse time data - this.openStrings.clear(); - this.openFilesets.clear(); - this.openRequirements.clear(); - this.files = null; - - // Parse the Document - try { - XMLReader xr = SAXParserFactory.newInstance().newSAXParser() - .getXMLReader(); - - xr.setContentHandler(this); - xr.setErrorHandler(this); - - xr.parse(descriptionSource); - - return; - } catch (ParserConfigurationException e) { - e.printStackTrace(); - } catch (SAXException e) { - e.getException().printStackTrace(); - } catch (IOException e) { - e.printStackTrace(); - } finally { - } - - } - - /** - * Parses start tag in XML stream. - * - * @see org.xml.sax.ContentHandler#startElement(java.lang.String, - * java.lang.String, java.lang.String, org.xml.sax.Attributes) - */ - public void startElement(String uri, String local, String qName, - Attributes atts) { - - if (TAG_THEME.equals(qName)) { - this.name = atts.getValue(ATTR_NAME); - } else if (TAG_DESCRIPTION.equals(qName)) { - this.description = "(none)"; - this.openStrings.push(new StringBuffer()); - } else if (TAG_EXTENDS.equals(qName)) { - String themeName = atts.getValue(ATTR_THEME); - if (this.name.equals(themeName)) - throw new IllegalArgumentException("Theme " + this.name - + " extends itself."); - if (parentTheme != null) - throw new IllegalArgumentException( - "Only one extends statement is allowed"); - this.parentTheme = themeName; - } else if (TAG_FILE.equals(qName)) { - File f = new File(atts.getValue(ATTR_NAME)); - if (this.openFilesets.isEmpty()) { - throw new IllegalStateException("Element '" + TAG_FILE - + "' must be within '" + TAG_FILESET + "' element."); - } - Fileset fs = (Fileset) this.openFilesets.peek(); - fs.addFile(f); - } else if (TAG_FILESET.equals(qName)) { - Fileset fs; - String mode = atts.getValue(ATTR_MODE); - if (mode != null && mode.length() == 0) - mode = null; - if (mode != null && !mode.equals(MODE_AJAX) - && !mode.equals(MODE_HTML)) - throw new IllegalStateException("Given mode '" + mode - + "' is not supported. (This version only supports '" - + MODE_HTML + "' and '" + MODE_AJAX + "')"); - fs = new Fileset(mode); - - // Uses the first fileset as root fileset - if (this.files == null) { - this.files = fs; - } - - // Adds inner filesets to parent - if (!this.openFilesets.isEmpty()) { - ((Fileset) this.openFilesets.peek()).addFile(fs); - } - - this.openFilesets.push(fs); - } else if (TAG_AUTHOR.equals(qName)) { - this.author = new Author(atts.getValue(ATTR_NAME), atts - .getValue(ATTR_EMAIL)); - } else if (TAG_MODES.equals(qName)) { - if (modesListCurrentlyOpen) - throw new IllegalStateException( - "Modes element can not be inside another modes element"); - modesListCurrentlyOpen = true; - } else if (TAG_MODE.equals(qName)) { - if (!modesListCurrentlyOpen) - throw new IllegalStateException( - "Mode elements must be placed inside modes element"); - if (currentlyOpenMode != null) - throw new IllegalStateException( - "No mode is allowed inside mode"); - String name = atts.getValue(ATTR_NAME); - if (name == null || name.length() == 0) - throw new IllegalStateException( - "Name is required for mode elements"); - this.currentlyOpenMode = name; - RequirementCollection rc = new AndRequirement(); - supportedModes.put(name, rc); - } - // Requirements - else if (TAG_REQUIRE.equals(qName)) { - if (currentlyOpenMode != null) { - RequirementCollection rc = (RequirementCollection) supportedModes - .get(this.currentlyOpenMode); - if (rc == null) - throw new IllegalStateException( - "Tried to add requirements to mode '" - + name - + "', but requirements set was not properly created. (internal error)"); - this.openRequirements.push(rc); - } else { - if (this.openFilesets.isEmpty()) { - throw new IllegalStateException("Element '" + TAG_REQUIRE - + "' must be within '" + TAG_FILESET + "' element."); - } - Fileset fs = (Fileset) this.openFilesets.peek(); - this.openRequirements.push(fs.getRequirements()); - } - } else if (TAG_SUPPORTS.equals(qName)) { - if (this.openFilesets.isEmpty() && currentlyOpenMode == null) { - throw new IllegalStateException("Element '" + TAG_REQUIRE - + "' must be within '" + TAG_FILESET + "' element."); - } - if (this.openRequirements.isEmpty()) { - throw new IllegalStateException("Element '" + TAG_SUPPORTS - + "' must be within '" + TAG_REQUIRE + "' element."); - } - this.addRequirements(atts, - (RequirementCollection) this.openRequirements.peek(), - this.isNOTRequirementOpen); - } else if (TAG_NOT.equals(qName)) { - this.isNOTRequirementOpen = true; - } else if (TAG_AND.equals(qName)) { - this.openRequirements.push(new AndRequirement()); - } else if (TAG_OR.equals(qName)) { - this.openRequirements.push(new OrRequirement()); - } - } - - /** - * Parses the end tag in XML stream. - * - * @see org.xml.sax.ContentHandler#endElement(String, String, String) - */ - public void endElement(String namespaceURI, String localName, String qName) - throws SAXException { - - if (TAG_FILESET.equals(qName)) { - this.openFilesets.pop(); - } else if (TAG_DESCRIPTION.equals(qName)) { - this.description = ((StringBuffer) this.openStrings.pop()) - .toString(); - } else if (TAG_REQUIRE.equals(qName)) { - this.openRequirements.pop(); - } else if (TAG_NOT.equals(qName)) { - this.isNOTRequirementOpen = false; - } else if (TAG_MODES.equals(qName)) { - this.modesListCurrentlyOpen = false; - } else if (TAG_MODE.equals(qName)) { - this.currentlyOpenMode = null; - } else if (TAG_OR.equals(qName) || TAG_AND.equals(qName)) { - RequirementCollection r = (RequirementCollection) openRequirements - .pop(); - if (openRequirements.size() < 1) - throw new IllegalStateException(); - ((RequirementCollection) openRequirements.peek()).addRequirement(r); - } - } - - /** - * Parses the character data in XML stream. - * - * @see org.xml.sax.ContentHandler#characters(char[], int, int) - */ - public void characters(char[] data, int start, int length) { - - // if stack is not ready, data is not content of recognized element - if (!this.openStrings.isEmpty()) { - ((StringBuffer) this.openStrings.peek()) - .append(data, start, length); - } else { - // read data which is not part of recognized element - } - } - - /** - * Adds all requirements specified in attributes to fileset. - * - * @param atts - * the Attribute set. - * @param requirements - * the Collection where to add requirement rules. - * @param applyNot - * the Should the meaning of these requirement be negated. - */ - private void addRequirements(Attributes atts, - RequirementCollection requirements, boolean applyNot) { - - // Creates temporary collection for requirements - Collection tmpReqs = new LinkedList(); - Requirement req = null; - - for (int i = 0; i < atts.getLength(); i++) { - req = null; - if (ATTR_JAVASCRIPT.equals(atts.getQName(i))) { - req = new JavaScriptRequirement(WebBrowser - .parseJavaScriptVersion(atts.getValue(i))); - } else if (ATTR_AGENT.equals(atts.getQName(i))) { - req = new AgentRequirement(atts.getValue(i)); - } else if (ATTR_MARKUP.equals(atts.getQName(i))) { - req = new MarkupLanguageRequirement(WebBrowser - .parseHTMLVersion(atts.getValue(i))); - } - // Adds to temporary requirement collection and clear reference - if (req != null) - tmpReqs.add(req); - } - - // Creates implicit AND requirement if more than one - // Rrequirements were specified in attributes - if (tmpReqs.size() > 1) { - req = new AndRequirement(tmpReqs); - } - - // Apply NOT rule if requested - if (applyNot) { - req = new NotRequirement(req); - } - - // Adds to requirements - requirements.addRequirement(req); - } - - /** - * Gets the list of all files in this theme. - * - * @return the List of filenames belonging to this theme. - */ - public List getFileNames() { - if (files == null) - return new LinkedList(); - return files.getFileNames(); - } - - /** - * Gets the list of file names matching WebBrowserType. - * - * @param terminal - * the type of the web browser. - * @param mode - * @return the list of filenames in this theme supporting the given - * terminal. - */ - public List getFileNames(WebBrowser terminal, String mode) { - if (files == null) - return new LinkedList(); - return this.files.getFileNames(terminal, mode); - } - - /** - * String representation of Theme object. Used for debugging purposes only. - * - * @see java.lang.Object#toString() - */ - public String toString() { - return this.name - + " author='" - + this.author - + "'" - + (parentTheme != null ? " inherits='" + parentTheme + "'" : "") - + " files={" + (files != null ? files.toString() : "null") - + "}"; - } - - /** - * Author information class. This class represents an single author of a - * theme package. Authors have name and contact email address properties. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class Author { - // name of the author. - private String name; - - // email address of the author. - private String email; - - /** - * Constructor for Author Information Class. - * - * @param name - * the name of the author. - * @param email - * the email address of the author. - */ - public Author(String name, String email) { - this.name = name; - this.email = email; - } - - /** - * Gets the name of the author. - * - * @return the Name of the author. - */ - public String getName() { - return this.name; - } - - /** - * Gets the email address of the author. - * - * @return the Email address of the author. - */ - public String getEmail() { - return this.email; - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - return name + "(" + email + ")"; - } - } - - /** - * Generic requirement. Interface implemented by requirements introducing - * method for checking compability with given terminal. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public interface Requirement { - - /** - * Checks that this requirement is met by given type of browser. - * - * @param terminal - * the type of the web browser. - * @return <code>true</code> if terminal is compatible with this - * rule,otherwise <code>false</code>. - * - */ - public boolean isMet(WebBrowser terminal); - - } - - /** - * Generic requirement collection interface. Requirement collection - * introducing methods for combining requirements into single requirement. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public interface RequirementCollection extends Requirement { - - /** - * Adds the new requirement to this collection. - * - * @param requirement - * the Requirement to be added. - */ - public void addRequirement(Requirement requirement); - - /** - * Removes the requirement from this collection. - * - * @param requirement - * the Requirement to be removed. - */ - public void removeRequirement(Requirement requirement); - } - - /** - * Logical NOT requirement. Requirement implementing logical NOT operation. - * Wraps an another requirement and negates the meaning of it. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class NotRequirement implements Requirement { - private Requirement requirement; - - /** - * Create a new NOT requirement based on another requirement. - * - * @param requirement - * the requirement to be negated. - */ - public NotRequirement(Requirement requirement) { - this.requirement = requirement; - } - - /** - * Check that this requirement is met by given type of browser. - * - * @param terminal - * the type of the web browser. - * @return <code>true</code> if terminal is compatible with this - * rule,otherwise <code>false</code>. - * - */ - public boolean isMet(WebBrowser terminal) { - return !this.requirement.isMet(terminal); - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - return "not(" + requirement + ")"; - } - - } - - /** - * Logical AND requirement. Implements a collection of requirements - * combining the included requirements using logical AND operation. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class AndRequirement implements RequirementCollection { - - private Collection requirements = new LinkedList(); - - public AndRequirement() { - } - - /** - * - * @param requirements - */ - public AndRequirement(Collection requirements) { - this.requirements.addAll(requirements); - } - - /** - * - * @param req1 - * @param req2 - */ - public AndRequirement(Requirement req1, Requirement req2) { - this.addRequirement(req1); - this.addRequirement(req2); - } - - /** - * Adds the new requirement to this collection. - * - * @see com.itmill.toolkit.terminal.web.Theme.RequirementCollection#addRequirement(com.itmill.toolkit.terminal.web.Theme.Requirement) - */ - public void addRequirement(Requirement requirement) { - this.requirements.add(requirement); - } - - /** - * Removes the requirement from this collection. - * - * @see com.itmill.toolkit.terminal.web.Theme.RequirementCollection#removeRequirement(com.itmill.toolkit.terminal.web.Theme.Requirement) - */ - public void removeRequirement(Requirement requirement) { - this.requirements.remove(requirement); - } - - /** - * Checks that all os the requirements in this collection are met. - * - * @param terminal - * the type of the web browser. - * @see Theme.Requirement#isMet(WebBrowser) - */ - public boolean isMet(WebBrowser terminal) { - for (Iterator i = this.requirements.iterator(); i.hasNext();) { - if (!((Requirement) i.next()).isMet(terminal)) { - return false; - } - } - return true; - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - String str = ""; - for (Iterator i = this.requirements.iterator(); i.hasNext();) { - if (!"".equals(str)) - str += " AND "; - str += "(" + ((Requirement) i.next()).toString() + ")"; - } - return str; - } - - } - - /** - * Logical OR requirement. Implements a collection of requirements combining - * the included requirements using logical AND operation. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class OrRequirement implements RequirementCollection { - - private Collection requirements = new LinkedList(); - - public OrRequirement() { - } - - /** - * - * @param requirements - */ - public OrRequirement(Collection requirements) { - this.requirements.addAll(requirements); - } - - /** - * - * @param req1 - * @param req2 - */ - public OrRequirement(Requirement req1, Requirement req2) { - this.addRequirement(req1); - this.addRequirement(req2); - } - - /** - * Adds the new requirement to this collection. - * - * @see com.itmill.toolkit.terminal.web.Theme.RequirementCollection#addRequirement(com.itmill.toolkit.terminal.web.Theme.Requirement) - */ - public void addRequirement(Requirement requirement) { - this.requirements.add(requirement); - } - - /** - * Removes the requirement from this collection. - * - * @see com.itmill.toolkit.terminal.web.Theme.RequirementCollection#removeRequirement(com.itmill.toolkit.terminal.web.Theme.Requirement) - */ - public void removeRequirement(Requirement requirement) { - this.requirements.remove(requirement); - } - - /** - * Checks that some of the requirements in this collection is met. - * - * @param terminal - * the type of the web browser. - * @see Theme.Requirement#isMet(WebBrowser) - */ - public boolean isMet(WebBrowser terminal) { - for (Iterator i = this.requirements.iterator(); i.hasNext();) { - if (((Requirement) i.next()).isMet(terminal)) { - return true; - } - } - return false; - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - String str = ""; - for (Iterator i = this.requirements.iterator(); i.hasNext();) { - if (!"".equals(str)) - str += " OR "; - str += "(" + ((Requirement) i.next()).toString() + ")"; - } - return str; - } - } - - /** - * HTTP user agent requirement This requirements is used to ensure that the - * User-Agent string provided in HTTP request headers contains given - * substring. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class AgentRequirement implements Requirement { - - private String agentSubstring; - - /** - * - * @param agentSubString - */ - public AgentRequirement(String agentSubString) { - this.agentSubstring = agentSubString; - } - - /** - * Checks that this requirement is met by given type of browser. - * - * @see com.itmill.toolkit.terminal.web.Theme.Requirement#isMet(com.itmill.toolkit.terminal.web.WebBrowser) - */ - public boolean isMet(WebBrowser terminal) { - return terminal.getBrowserApplication() - .indexOf(this.agentSubstring) >= 0; - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - return this.agentSubstring; - } - } - - /** - * Javascript version requirement This requirement is used to ensure a - * certain level of JavaScript version support. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class JavaScriptRequirement implements Requirement { - - private WebBrowser.JavaScriptVersion requiredVersion; - - /** - * - * @param requiredVersion - */ - public JavaScriptRequirement( - WebBrowser.JavaScriptVersion requiredVersion) { - this.requiredVersion = requiredVersion; - } - - /** - * Checks that this requirement is met by given type of browser. - * - * @see com.itmill.toolkit.terminal.web.Theme.Requirement#isMet(com.itmill.toolkit.terminal.web.WebBrowser) - */ - public boolean isMet(WebBrowser terminal) { - if (terminal.getJavaScriptVersion().supports(this.requiredVersion)) - return true; - return false; - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - return this.requiredVersion.toString(); - } - } - - /** - * Markup language version requirement. This requirement is used to ensure a - * certain level of Markup language version support. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class MarkupLanguageRequirement implements Requirement { - - private WebBrowser.MarkupVersion requiredVersion; - - /** - * - * @param requiredVersion - */ - public MarkupLanguageRequirement( - WebBrowser.MarkupVersion requiredVersion) { - this.requiredVersion = requiredVersion; - } - - /** - * Checks that this requirement is met by given type of browser. - * - * @see com.itmill.toolkit.terminal.web.Theme.Requirement#isMet(com.itmill.toolkit.terminal.web.WebBrowser) - */ - public boolean isMet(WebBrowser terminal) { - if (terminal.getMarkupVersion().supports(this.requiredVersion)) - return true; - return false; - - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - return this.requiredVersion.toString(); - } - - } - - /** - * Theme XSL file description Description of a single XSL file included a - * theme. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class File { - - private String name; - - /** - * Creates a new file. - * - * @param name - * the Name of the file. - */ - public File(String name) { - this.name = name; - } - - /** - * Gets the name of the file. The file name is relative and unique - * within a theme. - * - * @return the Name of the file. - */ - public String getName() { - return this.name; - } - - /** - * Does this file support the given terminal. Single file requirements - * are not supported and therefore this always returns true. - * - * @param terminal - * the type of the web browser. - * @return Always returns true. - * @see Theme.Fileset - */ - public boolean supports(WebBrowser terminal) { - return true; - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - return this.getName(); - } - - } - - /** - * A recursive set of files sharing the same requirements. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class Fileset extends File { - - private RequirementCollection requirements = new AndRequirement(); - - private Collection files = new LinkedList(); - - private String mode; - - /** - * Creates a new empty fileset. - * - * @param mode - * - */ - public Fileset(String mode) { - super(null); - this.mode = mode; - } - - /** - * Adds a file into fileset. - * - * @param file - * the file to add. - */ - private void addFile(File file) { - this.files.add(file); - } - - /** - * Gets the requirements in this fileset. - * - * @return the requirements. - */ - private RequirementCollection getRequirements() { - return this.requirements; - } - - /** - * Gets the list of all files in this theme. - * - * @return the list of filenames. - */ - public List getFileNames() { - - List list = new LinkedList(); - - for (Iterator i = this.files.iterator(); i.hasNext();) { - File f = (File) i.next(); - - // Recursively add included filesets - if (f instanceof Fileset) { - list.addAll(((Fileset) f).getFileNames()); - } else { - list.add(f.getName()); - } - } - return list; - - } - - /** - * Gets the list of file names matching WebBrowserType. - * - * @param terminal - * the type of the web browser. - * @param mode - * @return the list of filenames supporting the given terminal. - */ - public List getFileNames(WebBrowser terminal, String mode) { - - List list = new LinkedList(); - - // If this set is not supported by the terminal or is explicitly set - // into - // another mode, no files are given - if (!this.supports(terminal) - || (this.mode != null && !this.mode.equals(mode))) - return list; - - for (Iterator i = this.files.iterator(); i.hasNext();) { - File f = (File) i.next(); - - // Recursively add included filesets if they are - // supported - if (f instanceof Fileset) { - list.addAll(((Fileset) f).getFileNames(terminal, mode)); - - } else { - list.add(f.getName()); - } - } - return list; - } - - /** - * Does this file support the given terminal. - * - * @terminal the type of the web browser. - * @return True if fileset supports the given browser. False otherwise. - */ - public boolean supports(WebBrowser terminal) { - if (requirements.isMet(terminal)) - return true; - return false; - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - return "name=[" + this.getName() + "] requires=[" - + this.requirements + "] files=[" + files + "]"; - } - } - - /** - * Gets the author of this theme. - * - * @return the Author of the theme. - */ - public Author getAuthor() { - return author; - } - - /** - * Gets the name of this theme. - * - * @return the Name of the theme. - */ - public String getName() { - return name; - } - - /** - * Gets the name of the parent theme. - * - * @return the name of the parent theme. - */ - public String getParent() { - return parentTheme; - } - - /** - * Gets the theme description. - * - * @return the theme description. - */ - public String getDescription() { - return description; - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/ThemeFunctionLibrary.java b/src/com/itmill/toolkit/terminal/web/ThemeFunctionLibrary.java deleted file mode 100644 index e03f6b3d91..0000000000 --- a/src/com/itmill/toolkit/terminal/web/ThemeFunctionLibrary.java +++ /dev/null @@ -1,606 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import com.itmill.toolkit.Application; -import com.itmill.toolkit.terminal.ThemeResource; -import com.itmill.toolkit.ui.FrameWindow; -import com.itmill.toolkit.ui.Window; - -import java.text.DateFormatSymbols; -import java.util.Calendar; -import java.util.Collection; -import java.util.GregorianCalendar; -import java.util.Iterator; -import java.util.LinkedList; -import java.util.Map; -import java.util.Vector; - -import javax.servlet.http.HttpSession; - -/** - * This a function library that can be used from the theme XSL-files. It - * provides easy access to current application, window, theme, webbrowser and - * session. The internal threadlocal state must be maintained by the webadapter - * in order to guarantee that it works. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - -public class ThemeFunctionLibrary { - - static private final int APPLICATION = 0; - - static private final int WINDOW = 1; - - static private final int WEBBROWSER = 2; - - static private final int SESSION = 3; - - static private final int WEBADAPTERSERVLET = 4; - - static private final int THEME = 5; - - static private ThreadLocal state = new ThreadLocal(); - - /** - * - * @param application - * @param window - * @param webBrowser - * @param session - * @param webAdapterServlet - * @param theme - */ - static protected void setState(Application application, Window window, - WebBrowser webBrowser, HttpSession session, - ApplicationServlet webAdapterServlet, String theme) { - state.set(new Object[] { application, window, webBrowser, session, - webAdapterServlet, theme }); - } - - static protected void cleanState() { - state.set(null); - } - - /** - * Returns a reference to the application object associated with the session - * that the call came from. - */ - static public Application application() { - try { - return (Application) ((Object[]) state.get())[APPLICATION]; - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Returns a reference to the current window object associated with the - * session that the call came from. - */ - static public Window window() { - try { - return (Window) ((Object[]) state.get())[WINDOW]; - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Returns a reference to the browser object associated with the session - * that the call came from. - */ - static public WebBrowser browser() { - try { - return (WebBrowser) ((Object[]) state.get())[WEBBROWSER]; - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Returns a reference to the current servlet http session object that is - * associated with the session that the call came from. - */ - static public HttpSession session() { - try { - return (HttpSession) ((Object[]) state.get())[SESSION]; - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Returns a reference to the current theme name that is associated with the - * session that the call came from. - */ - static public String theme() { - try { - return (String) ((Object[]) state.get())[THEME]; - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Returns an URI to the named resource from the named theme. - * - * @param resource - * @param theme - */ - static public String resource(String resource, String theme) { - try { - return ((ApplicationServlet) ((Object[]) state.get())[WEBADAPTERSERVLET]) - .getResourceLocation(theme, new ThemeResource(resource)); - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Returns an URI to the named resource. - * - * @param resource - */ - static public String resource(String resource) { - try { - return ((ApplicationServlet) ((Object[]) state.get())[WEBADAPTERSERVLET]) - .getResourceLocation(theme(), new ThemeResource(resource)); - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Generates the JavaScript for page that performs client-side combility - * checks. - */ - static public boolean probeClient() { - return (browser().performClientCheck() && !browser() - .isClientSideChecked()); - } - - /** - * Generates the JavaScript for page header that handles window refreshing, - * opening and closing. - * - * Generates script that: - * <ul> - * <li>Requests that all windows that need repaint be reloaded</li> - * <li>Sets the window name</li> - * <li>Closes window if it is set to be closed </li> - * <ul> - * - * @return - */ - static public String windowScript() { - return generateWindowScript( - window(), - application(), - (ApplicationServlet) ((Object[]) state.get())[WEBADAPTERSERVLET], - browser()); - } - - /** - * - * @param window - * @param app - * @param wa - * @param browser - * @return - */ - static protected String generateWindowScript(Window window, - Application app, ApplicationServlet wa, WebBrowser browser) { - - StringBuffer script = new StringBuffer(); - LinkedList update = new LinkedList(); - - // Adds all the windows needto update list - Map dirtyWindows = wa != null ? wa.getDirtyWindows(app) : null; - if (dirtyWindows != null) - for (Iterator i = dirtyWindows.keySet().iterator(); i.hasNext();) { - Window w = (Window) i.next(); - if (w != window) { - if (w instanceof FrameWindow) - update.addFirst(w); - else - update.addLast(w); - } - } - - // Removes all windows that are in frames, of such frame windows that - // will be updated anyway - Object[] u = update.toArray(); - if (u.length > 0 && (window != null && window instanceof FrameWindow)) - u[u.length - 1] = window; - for (int i = 0; i < u.length; i++) { - try { - FrameWindow w = (FrameWindow) u[i]; - LinkedList framesets = new LinkedList(); - framesets.add(w.getFrameset()); - while (!framesets.isEmpty()) { - FrameWindow.Frameset fs = (FrameWindow.Frameset) framesets - .removeFirst(); - for (Iterator j = fs.getFrames().iterator(); j.hasNext();) { - FrameWindow.Frame f = (FrameWindow.Frame) j.next(); - if (f instanceof FrameWindow.Frameset) - framesets.add(f); - else if (f.getWindow() != null) { - update.remove(f.getWindow()); - wa.removeDirtyWindow(app, f.getWindow()); - } - } - } - } catch (ClassCastException ignored) { - } - } - - // Sets window name - if (window != null) { - script.append("window.name = \"" + getWindowTargetName(app, window) - + "\";\n"); - } - - // Generates window updatescript - for (Iterator i = update.iterator(); i.hasNext();) { - Window w = (Window) i.next(); - script.append(getWindowRefreshScript(app, w, browser)); - - wa.removeDirtyWindow(app, w); - - // Windows that are closed immediately are "painted" now - if (w.getApplication() == null || !w.isVisible()) - w.requestRepaintRequests(); - } - - // Closes current window if it is not visible - if (window == null || !window.isVisible()) - script.append("window.close();\n"); - - return script.toString(); - } - - /** - * Returns an unique target name for a given window name. - * - * @param application - * @param window - * the Name of the window. - * @return An unique ID for window target. - */ - static public String getWindowTargetName(Application application, - Window window) { - try { - return "" + application.hashCode() + "_" + window.getName(); - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Returns an unique target name for current window. - * - * @return An unique ID for window target. - */ - static public String getWindowTargetName() { - return getWindowTargetName(application(), window()); - } - - /** - * Returns an unique target name for current window. - * - * @param name - * the name of the window. - * @return An unique ID for window target. - */ - static public String getWindowTargetName(String name) { - Window w = application().getWindow(name); - if (w != null) - return getWindowTargetName(application(), w); - else - return name; - } - - /* Static mapping for 0 to be sunday. */ - private static int[] weekdays = new int[] { Calendar.SUNDAY, - Calendar.MONDAY, Calendar.TUESDAY, Calendar.WEDNESDAY, - Calendar.THURSDAY, Calendar.FRIDAY, Calendar.SATURDAY }; - - /** - * Returns the country and region code for current application locale. - * - * @return the language Country code of the current application locale. - * @see Locale#getCountry() - */ - static public String getLocaleCountryId() { - try { - Application app = (Application) ((Object[]) state.get())[APPLICATION]; - return app.getLocale().getCountry(); - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Returns the language code for current application locale. - * - * @return the Language code for current application locale. - * @see Locale#getLanguage() - */ - static public String getLocaleLanguageId() { - try { - Application app = (Application) ((Object[]) state.get())[APPLICATION]; - return app.getLocale().getLanguage(); - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Gets the name of first day of the week. - * - * @return - */ - static public int getFirstDayOfWeek() { - try { - Application app = (Application) ((Object[]) state.get())[APPLICATION]; - Calendar cal = new GregorianCalendar(app.getLocale()); - int first = cal.getFirstDayOfWeek(); - for (int i = 0; i < 7; i++) { - if (first == weekdays[i]) - return i; - } - return 0; // default to sunday - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Gets the name for week day. - * - * @param dayOfWeek - * the Number of week day. 0 sunday, 1 monday, ... - * @return the Name of week day in applications current locale. - */ - static public String getShortWeekday(int dayOfWeek) { - try { - Application app = (Application) ((Object[]) state.get())[APPLICATION]; - DateFormatSymbols df = new DateFormatSymbols(app.getLocale()); - return df.getShortWeekdays()[weekdays[dayOfWeek]]; - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Gets the short name for month. - * - * @param month - * the Number of month. 0 is January, 1 is February, and so on. - * @return the Name of month in applications current locale. - */ - static public String getShortMonth(int month) { - try { - Application app = (Application) ((Object[]) state.get())[APPLICATION]; - DateFormatSymbols df = new DateFormatSymbols(app.getLocale()); - String monthName = df.getShortMonths()[month]; - return monthName; - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Gets the name for month. - * - * @param month - * the Number of month. 0 is January, 1 is February, and so on. - * @return the Name of month in applications current locale. - */ - static public String getMonth(int month) { - try { - Application app = (Application) ((Object[]) state.get())[APPLICATION]; - DateFormatSymbols df = new DateFormatSymbols(app.getLocale()); - String monthName = df.getMonths()[month]; - return monthName; - } catch (NullPointerException e) { - throw new IllegalStateException(); - } - } - - /** - * Gets Form Action URL for the requested window. - * - * <p> - * This returns the action for the window main form. This action can be set - * through WebApplicationContect setWindowFormAction method.. - * </p> - * - * @return the Form action for the current window. - */ - static public String getFormAction() { - - Window win = window(); - Application app = application(); - - return ((WebApplicationContext) app.getContext()) - .getWindowFormAction(win); - } - - /** - * Generates the links for CSS files to be included in html head. - * - * @return - */ - static public String getCssLinksForHead() { - ApplicationServlet as = (ApplicationServlet) ((Object[]) state.get())[WEBADAPTERSERVLET]; - Theme t = as.getThemeSource().getThemeByName(theme()); - - // Also iterate parent themes - Vector themes = new Vector(); - themes.add(t); - while (t.getParent() != null) { - String parentName = t.getParent(); - t = as.getThemeSource().getThemeByName(parentName); - themes.add(t); - } - - // Generates links - StringBuffer links = new StringBuffer(); - for (int k = themes.size() - 1; k >= 0; k--) { - Collection allFiles = ((Theme) themes.get(k)).getFileNames( - browser(), Theme.MODE_HTML); - for (Iterator i = allFiles.iterator(); i.hasNext();) { - String file = (String) i.next(); - if (file.endsWith(".css")) { - links - .append("<LINK REL=\"STYLESHEET\" TYPE=\"text/css\" HREF=\"" - + resource(file) + "\"/>\n"); - } - } - } - - return links.toString(); - } - - /** - * Generates the links for JavaScript files to be included in html head. - * - * @return - */ - static public String getJavaScriptLinksForHead() { - ApplicationServlet as = (ApplicationServlet) ((Object[]) state.get())[WEBADAPTERSERVLET]; - Theme t = as.getThemeSource().getThemeByName(theme()); - - // Also iterate parent themes - Vector themes = new Vector(); - themes.add(t); - while (t.getParent() != null) { - String parentName = t.getParent(); - t = as.getThemeSource().getThemeByName(parentName); - themes.add(t); - } - - // Generates links - StringBuffer links = new StringBuffer(); - for (int k = themes.size() - 1; k >= 0; k--) { - Collection allFiles = ((Theme) themes.get(k)).getFileNames( - browser(), Theme.MODE_HTML); - for (Iterator i = allFiles.iterator(); i.hasNext();) { - String file = (String) i.next(); - if (file.endsWith(".js")) { - links.append("<SCRIPT LANGUAGE=\"Javascript\" SRC=\"" - + resource(file) + "\"></SCRIPT>\n"); - } - } - } - - return links.toString(); - } - - /** - * Generates the JavaScript for updating given window. - * - * @param application - * @param window - * @param browser - * @return - */ - static protected String getWindowRefreshScript(Application application, - Window window, WebBrowser browser) { - - if (application == null) - return ""; - - if (window == null) - return ""; - - if (window == null) - return ""; - - // If window is closed or hidden - if (window.getApplication() == null || !window.isVisible()) - return "win = window.open(\"\",\"" - + getWindowTargetName(application, window) + "\");\n " - + "if (win != null) { win.close(); }\n"; - - String url = window.getURL().toString(); - - String features = "dependent=yes,"; - int width = window.getWidth(); - int height = window.getHeight(); - if (width >= 0) - features += "width=" + width; - if (height >= 0) - features += ((features.length() > 0) ? "," : "") + "height=" - + height; - switch (window.getBorder()) { - case Window.BORDER_NONE: - features += ((features.length() > 0) ? "," : "") - + "toolbar=0,location=0,menubar=0,status=0,resizable=1,scrollbars=" - + (window.isScrollable() ? "1" : "0"); - break; - case Window.BORDER_MINIMAL: - features += ((features.length() > 0) ? "," : "") - + "toolbar=1,location=0,menubar=0,status=1,resizable=1,scrollbars=" - + (window.isScrollable() ? "1" : "0"); - break; - case Window.BORDER_DEFAULT: - features += ((features.length() > 0) ? "," : "") - + "toolbar=1,location=1,menubar=1,status=1,resizable=1,scrollbars=" - + (window.isScrollable() ? "1" : "0"); - break; - } - - String script = "win = window.open(\"\",\"" - + getWindowTargetName(application, window) + "\",\"" + features - + "\");\n" + "if (win != null) {" + "var form = null;"; - - if (browser != null - && (browser.getJavaScriptVersion().supports( - WebBrowser.JAVASCRIPT_1_5) || browser - .getJavaScriptVersion() - .supports(WebBrowser.JSCRIPT_1_0))) { - script += "try { form = win.document.forms[\"itmill\"]; if (typeof form == 'undefined') form = win.document.forms[\"millstone\"];" - + "} catch (e) { form = null;}"; - } else { - script += "form = win.document.forms[\"itmill\"]; if (typeof form == 'undefined') form = win.document.forms[\"millstone\"];"; - } - - script += "if (form != null) {" + "form.submit();" - + "} else {win.location.href = \"" + url + "\";}}"; - - return script; - } -} diff --git a/src/com/itmill/toolkit/terminal/web/ThemeSource.java b/src/com/itmill/toolkit/terminal/web/ThemeSource.java deleted file mode 100644 index c2ff054683..0000000000 --- a/src/com/itmill/toolkit/terminal/web/ThemeSource.java +++ /dev/null @@ -1,183 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.io.InputStream; -import java.util.Collection; - -/** - * Interface implemented by theme sources. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public interface ThemeSource { - - /** - * Gets the name of the ThemeSource. - * - * @return the Name of the theme source. - */ - public String getName(); - - /** - * Gets the XSL stream for the specified theme and web-browser type. Returns - * the XSL templates, which are used to process the UIDL data. The - * <code>type</code> parameter is used to limit the templates, which are - * returned based on the theme fileset requirements. - * <p> - * Note : This implicitly operates in xslt mode. - * </p> - * - * @param theme - * the Theme, which XSL should be returned. - * @param type - * the type of the current client. - * @return Collection of ThemeSource.XSLStream objects. - * @throws ThemeException - * If the resource is not found or there was some problem - * finding the resource. - * @see Theme - */ - public Collection getXSLStreams(Theme theme, WebBrowser type) - throws ThemeException; - - /** - * Gets the last modification time, used to reload theme on changes. - * - * @return the Last modification time of the theme source. - */ - public long getModificationTime(); - - /** - * Gets the input stream for the resource with the specified resource id. - * - * @param resourceId - * the resource id. - * @return Stream where the resource can be read. - * @throws ThemeException - * If the resource is not found or there was some problem - * finding the resource. - */ - public InputStream getResource(String resourceId) throws ThemeException; - - /** - * Gets the list of themes in the theme source. - * - * @return the List of themes included in the theme source. - */ - public Collection getThemes(); - - /** - * Returns the Theme instance by name. - * - * @param name - * the Theme name. - * @return the Theme instance matching the name, or null if not found. - */ - public Theme getThemeByName(String name); - - /** - * <code>ThemeException</code> is thrown by classes implementing the - * <code>ThemeSource</code> interface if some error occurs during - * processing. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - public class ThemeException extends Exception { - - private static final long serialVersionUID = -7823850742197580285L; - - /** - * Creates a new theme exception. - * - * @param message - * the Error message. - */ - public ThemeException(String message) { - super(message); - } - - /** - * Creates a new theme exception. - * - * @param message - * the error message. - * @param cause - * the cause of the exception. - */ - public ThemeException(String message, Throwable cause) { - super(message, cause); - } - } - - /** - * Wrapper class for XSL InputStreams. - */ - public class XSLStream { - private String id; - - private InputStream stream; - - /** - * - * @param id - * @param stream - * the input stream. - */ - public XSLStream(String id, InputStream stream) { - this.id = id; - this.stream = stream; - } - - /** - * Returns id of this stream. - * - * @return the id of the stream. - */ - public String getId() { - return id; - } - - /** - * Returns the actual XSL Stream. - * - * @return the XSL Stream. - */ - public InputStream getStream() { - return stream; - } - - } -} diff --git a/src/com/itmill/toolkit/terminal/web/UIDLTransformer.java b/src/com/itmill/toolkit/terminal/web/UIDLTransformer.java deleted file mode 100644 index 694f068045..0000000000 --- a/src/com/itmill/toolkit/terminal/web/UIDLTransformer.java +++ /dev/null @@ -1,670 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import org.xml.sax.InputSource; -import org.xml.sax.SAXException; -import org.xml.sax.SAXParseException; -import org.xml.sax.XMLReader; -import org.xml.sax.helpers.XMLReaderFactory; - -import com.itmill.toolkit.terminal.PaintException; - -import java.io.BufferedOutputStream; -import java.io.IOException; -import java.io.OutputStream; -import java.io.StringReader; -import java.util.Collection; -import java.util.LinkedList; -import java.util.Hashtable; -import java.util.Iterator; - -import javax.xml.transform.sax.SAXSource; -import javax.xml.transform.stream.StreamResult; -import javax.xml.transform.ErrorListener; -import javax.xml.transform.SourceLocator; -import javax.xml.transform.OutputKeys; - -/** - * Class implementing the UIDLTransformer. - * - * The transformer should not be created directly; it should be contructed using - * <code>getTransformer</code> provided by <code>UIDLTransformerFactory</code>. - * - * After the transform has been done, the transformer can be recycled with - * <code>releaseTransformer</code> by <code>UIDLTransformerFactory</code>. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - -public class UIDLTransformer { - - /** - * XSLT factory. - */ - protected static javax.xml.transform.TransformerFactory xsltFactory; - static { - xsltFactory = javax.xml.transform.TransformerFactory.newInstance(); - if (xsltFactory == null) - throw new RuntimeException("Could not instantiate " - + "transformer factory. Maybe XSLT processor is " - + "not included in classpath."); - } - - /** - * Source of the transform containing UIDL. - */ - private WebPaintTarget paintTarget; - - /** - * Holds the type of the transformer. - */ - private UIDLTransformerType transformerType; - - /** - * Prepared XSLT transformer for UIDL transformations. - */ - private javax.xml.transform.Transformer uidlTransformer; - - /** - * Error handled used. - */ - private TransformerErrorHandler errorHandler; - - /** - * Theme repository used for late error reporting. - */ - private ThemeSource themeSource; - - private ApplicationServlet webAdapterServlet; - - /** - * UIDLTransformer constructor. - * - * @param type - * the Type of the transformer. - * @param themes - * the theme implemented by the transformer. - * @param webAdapterServlet - * the Adapter servlet. - * @throws UIDLTransformerException - * UIDLTransformer exception is thrown, if the transform can not - * be created. - */ - public UIDLTransformer(UIDLTransformerType type, ThemeSource themes, - ApplicationServlet webAdapterServlet) - throws UIDLTransformerException { - this.transformerType = type; - this.themeSource = themes; - this.webAdapterServlet = webAdapterServlet; - - // Registers the error handler - errorHandler = new TransformerErrorHandler(); - xsltFactory.setErrorListener(errorHandler); - - try { - - // Creates XML Reader to be used by - // XSLReader as the actual parser object. - XMLReader parser = XMLReaderFactory.createXMLReader(); - - // Creates XML reader for concatenating - // multiple XSL files as one. - - XMLReader xmlReader = new XSLReader(parser, themes.getXSLStreams( - type.getTheme(), type.getWebBrowser())); - - xmlReader.setErrorHandler(errorHandler); - - // Creates own SAXSource using a dummy inputSource. - SAXSource source = new SAXSource(xmlReader, new InputSource()); - uidlTransformer = xsltFactory.newTransformer(source); - - if (uidlTransformer != null) { - - // Registers transformer error handler - uidlTransformer.setErrorListener(errorHandler); - - // Ensures HTML output - uidlTransformer.setOutputProperty(OutputKeys.METHOD, "html"); - - // Ensures no indent - uidlTransformer.setOutputProperty(OutputKeys.INDENT, "no"); - } - - // Checks if transform itself failed, meaning either - // UIDL error or error in XSL/T semantics (like XPath) - if (errorHandler.hasFatalErrors()) { - throw new UIDLTransformerException( - "XSL Transformer creation failed", errorHandler - .getFirstFatalError(), errorHandler - .getUIDLErrorReport() - + "<br /><br />" - + errorHandler.getXSLErrorReport(themeSource, - transformerType)); - } - - } catch (Exception e) { - // Pass the new XHTML coded error forwards - throw new UIDLTransformerException(e.toString(), e, errorHandler - .getXSLErrorReport(themeSource, transformerType)); - } - } - - /** - * Gets the type of the transformer. - * - * @return the Type of the transformer. - */ - public UIDLTransformerType getTransformerType() { - return this.transformerType; - } - - /** - * Attaches the output stream to transformer and get corresponding - * UIDLStream for writing UI description language trough transform to given - * output. - * - * @param variableMap - * the variable map used for UIDL creation. - * @return returns UI description language stream, that can be used for - * writing UIDL to transformer. - */ - public WebPaintTarget getPaintTarget(HttpVariableMap variableMap) { - - try { - paintTarget = new WebPaintTarget(variableMap, transformerType, - webAdapterServlet, transformerType.getTheme()); - } catch (PaintException e) { - throw new IllegalArgumentException( - "Failed to instantiate new WebPaintTarget: " + e); - } - return paintTarget; - } - - /** - * Resets the transformer, before it can be used again. This also interrupts - * any ongoing transform and thus should not be called before the transform - * is ready. This is automatically called by the UIDLTransformFactory, when - * the UIDLTransformer has been released. - * - * @see UIDLTransformerFactory#releaseTransformer(UIDLTransformer) - */ - protected void reset() { - if (paintTarget != null) { - try { - paintTarget.close(); - } catch (PaintException e) { - // Ignore this exception - } - paintTarget = null; - } - if (errorHandler != null) - errorHandler.clear(); - } - - /** - * Transforms the UIDL to HTML and output to the OutputStream. - * - * @param outputStream - * the output stream to render to. - * @throws UIDLTransformerException - * UIDLTransformer exception is thrown, if the transform can not - * be created. - */ - public void transform(OutputStream outputStream) - throws UIDLTransformerException { - - StreamResult result = new StreamResult(new BufferedOutputStream( - outputStream)); - - // XSL Transform - try { - InputSource uidl = new InputSource(new StringReader(paintTarget - .getUIDL())); - XMLReader reader = org.xml.sax.helpers.XMLReaderFactory - .createXMLReader(); - reader.setErrorHandler(this.errorHandler); - - // Validates if requested. We validate the UIDL separately, - // toget the SAXExceptions instead of TransformerExceptions. - // This is required to get the line numbers right. - /* - * FIXME: Disable due abnormalities in DTD handling. if - * (webAdapterServlet.isDebugMode()) { reader.setFeature( - * "http://xml.org/sax/features/validation", true); - * reader.parse(uidl); uidl = new InputSource(new - * StringReader(paintTarget.getUIDL())); } - */ - SAXSource source = new SAXSource(reader, uidl); - - // TODO HTML mode under heavy load provides - // java.net.SocketException: broken pipe - uidlTransformer.transform(source, result); - } catch (Exception e) { - // XSL parsing failed. Pass the new XHTML coded error forwards - throw new UIDLTransformerException(e.toString(), e, errorHandler - .getUIDLErrorReport()); - } - - // Checks if transform itself failed, meaning either - // UIDL error or error in XSL/T semantics (like XPath) - if (errorHandler.hasFatalErrors()) { - throw new UIDLTransformerException("UIDL Transform failed", - errorHandler.getFirstFatalError(), errorHandler - .getUIDLErrorReport() - + "<br /><br />" - + errorHandler.getXSLErrorReport(themeSource, - transformerType)); - } - } - - /** - * - * - * - */ - protected class TransformerErrorHandler implements ErrorListener, - org.xml.sax.ErrorHandler { - - LinkedList errors = new LinkedList(); - - LinkedList warnings = new LinkedList(); - - LinkedList fatals = new LinkedList(); - - Hashtable rowToErrorMap = new Hashtable(); - - Hashtable errorToRowMap = new Hashtable(); - - /** - * - * @return - */ - public boolean hasNoErrors() { - return errors.isEmpty() && warnings.isEmpty() && fatals.isEmpty(); - } - - /** - * - * @return - */ - public boolean hasFatalErrors() { - return !fatals.isEmpty(); - } - - /** - * - * - */ - public void clear() { - errors.clear(); - warnings.clear(); - fatals.clear(); - } - - /** - * @see java.lang.Object#toString() - */ - public String toString() { - return getHTMLErrors("Fatal Errors", fatals) + "<br />" - + getHTMLErrors("Errors", errors) + "<br />" - + getHTMLErrors("Warnings", warnings) + "<br />"; - } - - /** - * - * @param title - * @param l - * @return - */ - private String getHTMLErrors(String title, LinkedList l) { - String r = ""; - r = "<b>" + title + "</b><br />"; - if (l.size() > 0) { - for (Iterator i = l.iterator(); i.hasNext();) { - Exception e = (Exception) i.next(); - if (e instanceof javax.xml.transform.TransformerException) { - Integer line = (Integer) errorToRowMap.get(e); - r += " - " - + WebPaintTarget - .escapeXML(((javax.xml.transform.TransformerException) e) - .getMessage()); - Throwable cause = ((javax.xml.transform.TransformerException) e) - .getException(); - - // Append cause if available - if (cause != null) { - r += ": " - + WebPaintTarget.escapeXML(cause - .getMessage()); - } - r += line != null ? " (line:" + line.intValue() + ")" - : " (line unknown)"; - r += "<br />\n"; - } else { - Integer line = (Integer) errorToRowMap.get(e); - r += " - " + WebPaintTarget.escapeXML(e.toString()); - r += line != null ? " (line:" + line.intValue() + ")" - : " (line unknown)"; - r += "<br />\n"; - - } - } - } - return r; - } - - /** - * @see javax.xml.transform.ErrorListener#error(TransformerException) - */ - public void error(javax.xml.transform.TransformerException exception) { - if (exception != null) { - errors.addLast(exception); - SourceLocator l = exception.getLocator(); - if (l != null) { - rowToErrorMap.put(new Integer( - ((XSLReader.XSLStreamLocator) l).getLineNumber()), - exception); - errorToRowMap.put(exception, new Integer( - ((XSLReader.XSLStreamLocator) l).getLineNumber())); - } - } - } - - /** - * @see javax.xml.transform.ErrorListener#fatalError(TransformerException) - */ - public void fatalError( - javax.xml.transform.TransformerException exception) { - if (exception != null) { - fatals.addLast(exception); - SourceLocator l = exception.getLocator(); - if (l != null) { - rowToErrorMap - .put(new Integer(l.getLineNumber()), exception); - errorToRowMap - .put(exception, new Integer(l.getLineNumber())); - } - } - } - - /** - * @see javax.xml.transform.ErrorListener#warning(TransformerException) - */ - public void warning(javax.xml.transform.TransformerException exception) { - if (exception != null) { - warnings.addLast(exception); - SourceLocator l = exception.getLocator(); - if (l != null) { - rowToErrorMap - .put(new Integer(l.getLineNumber()), exception); - errorToRowMap - .put(exception, new Integer(l.getLineNumber())); - } - } - } - - /** - * Gets the formated error report on XSL. - * - * @param themes - * @param type - */ - public String getXSLErrorReport(ThemeSource themes, - UIDLTransformerType type) { - - // Recreates the XSL for error reporting - StringBuffer readBuffer = new StringBuffer(); - try { - Collection c = themes.getXSLStreams(type.getTheme(), type - .getWebBrowser()); - for (Iterator i = c.iterator(); i.hasNext();) { - - java.io.InputStream is = ((ThemeSource.XSLStream) i.next()) - .getStream(); - byte[] buffer = new byte[1024]; - int read = 0; - while ((read = is.read(buffer)) >= 0) - readBuffer.append(new String(buffer, 0, read)); - } - } catch (IOException ignored) { - - } catch (ThemeSource.ThemeException ignored) { - - } - - String xsl = "XSL Source not avaialable"; - if (readBuffer != null) - xsl = readBuffer.toString(); - - StringBuffer sb = new StringBuffer(); - - // Print formatted UIDL with errors embedded - - int row = 0; - int prev = 0; - int index = 0; - int errornro = 0; - boolean lastLineWasEmpty = false; - - sb.append(toString()); - sb - .append("<font size=\"+1\"><a href=\"#err1\">" - + "Go to first error</a></font>" - + "<table width=\"100%\" style=\"border-left: 1px solid black; " - + "border-right: 1px solid black; border-bottom: " - + "1px solid black; border-top: 1px solid black\"" - + " cellpadding=\"0\" cellspacing=\"0\" border=\"0\"><tr>" - + "<th bgcolor=\"#ddddff\" colspan=\"2\">" - + "<font size=\"+2\">XSL</font><br />" - + "</th></tr>\n"); - - while ((index = xsl.indexOf('\n', prev)) >= 0) { - String line = xsl.substring(prev, index); - prev = index + 1; - row++; - - Exception exp = (Exception) rowToErrorMap.get(new Integer(row)); - line = WebPaintTarget.escapeXML(line); - boolean isEmpty = (line.length() == 0 || line.equals("\r")); - - // Code beautification : Comment lines - line = xmlHighlight(line); - - String head = ""; - String tail = ""; - - if (exp != null) { - errornro++; - head = "<a name=\"err" + String.valueOf(errornro) - + "\"><table width=\"100%\">" - + "<tr><th bgcolor=\"#ff3030\">" - + exp.getLocalizedMessage() + "</th></tr>" - + "<tr><td bgcolor=\"#ffcccc\">"; - tail = "</tr><tr><th bgcolor=\"#ff3030\">" - + (errornro > 1 ? "<a href=\"#err" - + String.valueOf(errornro - 1) - + "\">Previous error</a> " : "") - + "<a href=\"#err" + String.valueOf(errornro + 1) - + "\">Next error</a>" + "</th></tr></table></a>\n"; - } - - if (!(isEmpty && lastLineWasEmpty)) - sb - .append("<tr" - + ((row % 10) > 4 ? " bgcolor=\"#eeeeff\"" - : "") - + "><td style=\"border-right: 1px solid gray\"> " - + String.valueOf(row) + " </td><td>" - + head + "<nobr>" + line + "</nobr>" + tail - + "</td></tr>\n"); - - lastLineWasEmpty = isEmpty; - - } - - sb.append("</table>\n"); - - return sb.toString(); - } - - /** - * Gets the formated error report on UIDL. - * - * @return the formatted error report. - */ - public String getUIDLErrorReport() { - - String uidl = "UIDL Source Not Available."; - if (paintTarget != null) - uidl = paintTarget.getUIDL(); - StringBuffer sb = new StringBuffer(); - - // Prints the formatted UIDL with errors embedded - int row = 0; - int prev = 0; - int index = 0; - boolean lastLineWasEmpty = false; - - // Appends the error report - sb.append(toString()); - - // Appends UIDL - sb - .append("<table width=\"100%\" style=\"border-left: 1px solid black; " - + "border-right: 1px solid black; border-bottom: " - + "1px solid black; border-top: 1px solid black\"" - + " cellpadding=\"0\" cellspacing=\"0\" border=\"0\"><tr>" - + "<th bgcolor=\"#ddddff\" colspan=\"2\">" - + "<font size=\"+2\">UIDL</font><br />" - + "</th></tr>\n"); - - while ((index = uidl.indexOf('\n', prev)) >= 0) { - String line = uidl.substring(prev, index); - prev = index + 1; - row++; - - line = WebPaintTarget.escapeXML(line); - boolean isEmpty = (line.length() == 0 || line.equals("\r")); - - // Highlight source - // line = xmlHighlight(line); - - if (!(isEmpty && lastLineWasEmpty)) - sb - .append("<tr" - + ((row % 10) > 4 ? " bgcolor=\"#eeeeff\"" - : "") - + "><td style=\"border-right: 1px solid gray\"> " - + String.valueOf(row) + " </td><td>" - + "<nobr>" + line + "</nobr>" - + "</td></tr>\n"); - - lastLineWasEmpty = isEmpty; - } - - sb.append("</table>\n"); - - return sb.toString(); - } - - /** - * Highlights the XML source. - * - * @param xmlSnippet - * @return - */ - private String xmlHighlight(String xmlSnippet) { - String res = xmlSnippet; - - // Code beautification : Comment lines - DebugWindow.replaceAll(res, "<!--", - "<SPAN STYLE=\"color: #00dd00\"><!--"); - res = DebugWindow.replaceAll(res, "-->", "--></SPAN>"); - - // nbsp instead of blanks - String l = " "; - while (res.startsWith(" ")) { - l += " "; - res = res.substring(1, res.length()); - } - res = l + res; - - return res; - } - - /** - * Gets the first fatal error. - * - * @return the fatal error. - */ - public Throwable getFirstFatalError() { - return (Throwable) fatals.iterator().next(); - } - - /** - * @see org.xml.sax.ErrorHandler#error(SAXParseException) - */ - public void error(SAXParseException exception) throws SAXException { - errors.addLast(exception); - rowToErrorMap - .put(new Integer(exception.getLineNumber()), exception); - errorToRowMap - .put(exception, new Integer(exception.getLineNumber())); - } - - /** - * @see org.xml.sax.ErrorHandler#fatalError(SAXParseException) - */ - public void fatalError(SAXParseException exception) throws SAXException { - fatals.addLast(exception); - rowToErrorMap - .put(new Integer(exception.getLineNumber()), exception); - errorToRowMap - .put(exception, new Integer(exception.getLineNumber())); - } - - /** - * @see org.xml.sax.ErrorHandler#warning(SAXParseException) - */ - public void warning(SAXParseException exception) throws SAXException { - warnings.addLast(exception); - rowToErrorMap - .put(new Integer(exception.getLineNumber()), exception); - errorToRowMap - .put(exception, new Integer(exception.getLineNumber())); - } - - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/UIDLTransformerException.java b/src/com/itmill/toolkit/terminal/web/UIDLTransformerException.java deleted file mode 100644 index 2aa9c8b535..0000000000 --- a/src/com/itmill/toolkit/terminal/web/UIDLTransformerException.java +++ /dev/null @@ -1,89 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -/** - * Exception in the transform process. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public class UIDLTransformerException extends java.lang.Exception { - - private static final long serialVersionUID = 5648982356058143223L; - - private String HTMLDescription = null; - - private Throwable transformException = null; - - /** - * Creates a new instance of UIDLTransformerException without detail - * message. - */ - public UIDLTransformerException() { - } - - /** - * Constructs an instance of UIDLTransformerException with the specified - * detail message. - * - * @param msg - * the description of exception that occurred. - * @param te - * the Transform exception that occurred. - * @param desc - * the detailed description. - */ - public UIDLTransformerException(String msg, Throwable te, String desc) { - super(msg); - this.transformException = te; - this.HTMLDescription = desc; - } - - /** - * Returns the detailed description. - * - * @return the Detailed description of exception. - */ - public String getHTMLDescription() { - return HTMLDescription; - } - - /** - * Returns the nested transform exception that occurred. - * - * @return the transform exception - */ - public Throwable getTransformException() { - return transformException; - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/UIDLTransformerFactory.java b/src/com/itmill/toolkit/terminal/web/UIDLTransformerFactory.java deleted file mode 100644 index abaecd7f8a..0000000000 --- a/src/com/itmill/toolkit/terminal/web/UIDLTransformerFactory.java +++ /dev/null @@ -1,347 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.util.Date; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedList; -import java.util.Map; -import java.util.Iterator; - -/** - * Class implementing the UIDLTransformer Factory. The factory creates and - * maintains a pool of transformers that are used for transforming UIDL to HTML. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - -public class UIDLTransformerFactory { - - /** - * Time between repository modified queries. - */ - private static final int CACHE_CHECK_INTERVAL_MILLIS = 5 * 1000; - - /** - * The time transformers are cached by default. - */ - private static final long DEFAULT_TRANSFORMER_CACHETIME = 60 * 60 * 1000; - - /** - * Maximum number of transformers in use. - */ - private int maxConcurrentTransformers = 1; - - /** - * Last time theme modification time was checked. - */ - private long lastModificationCheckTime = 0; - - /** - * Last time theme source was modified. - */ - private long themeSourceModificationTime = 0; - - /** - * How long to cache transformers. - */ - private long cacheTime = DEFAULT_TRANSFORMER_CACHETIME; - - /** - * Spool manager thread. - */ - private SpoolManager spoolManager; - - private Map transformerSpool = new HashMap(); - - private ThemeSource themeSource; - - private ApplicationServlet webAdapterServlet; - - private int transformerCount = 0; - - private int transformersInUse = 0; - - /** - * Constructor for transformer factory. Method UIDLTransformerFactory. - * - * @param themeSource - * the Theme source to be used for themes. - * @param webAdapterServlet - * the Adapter servlet. - * @param maxConcurrentTransformers - * the Maximum number of concurrent themes in use. - * @param cacheTime - * the Time to cache the transformers. - */ - public UIDLTransformerFactory(ThemeSource themeSource, - ApplicationServlet webAdapterServlet, - int maxConcurrentTransformers, long cacheTime) { - this.webAdapterServlet = webAdapterServlet; - if (themeSource == null) - throw new NullPointerException(); - this.themeSource = themeSource; - this.themeSourceModificationTime = themeSource.getModificationTime(); - this.maxConcurrentTransformers = maxConcurrentTransformers; - if (cacheTime >= 0) - this.cacheTime = cacheTime; - this.spoolManager = new SpoolManager(this.cacheTime); - this.spoolManager.setDaemon(true); - // Enable manager only if time > 0 - if (this.cacheTime > 0) - this.spoolManager.start(); - } - - /** - * Gets the new transformer of the specified type. - * - * @param type - * the Type of the requested transformer. - * @return Created new transformer. - * @throws UIDLTransformerException - * if the transform can not be created. - */ - public synchronized UIDLTransformer getTransformer(UIDLTransformerType type) - throws UIDLTransformerException { - - while (transformersInUse >= maxConcurrentTransformers) { - try { - this.wait(); - } catch (InterruptedException e) { - return null; - } - } - - // Gets the list of transformers for this type - TransformerList list = (TransformerList) this.transformerSpool - .get(type); - - // Checks the modification time between fixed intervals - long now = System.currentTimeMillis(); - if (now - CACHE_CHECK_INTERVAL_MILLIS > this.lastModificationCheckTime) { - - this.lastModificationCheckTime = now; - - // Checks if the theme source has been modified and flush - // list if necessary - long lastmod = this.themeSource.getModificationTime(); - if (list != null && this.themeSourceModificationTime < lastmod) { - if (webAdapterServlet.isDebugMode(null)) { - Log.info("Theme source modified since " - + new Date(this.themeSourceModificationTime) - .toString() + ". Reloading..."); - } - // Force refresh by removing from spool - this.transformerSpool.clear(); - list = null; - this.transformerCount = 0; - this.themeSourceModificationTime = lastmod; - } - } - - UIDLTransformer t = null; - - if (list != null && !list.isEmpty()) { - // If available, return the first available transformer - t = (UIDLTransformer) list.removeFirst(); - if (webAdapterServlet.isDebugMode(null)) { - Log.info("Reserved existing transformer: " + type); - } - } else { - - // Creates the new transformer and return it. Transformers are added - // to - // spool when they are released. - t = new UIDLTransformer(type, themeSource, webAdapterServlet); - transformerCount++; - if (webAdapterServlet.isDebugMode(null)) { - Log.info("Created new transformer (" + transformerCount + "):" - + type); - } - - // Creates the new list, if not found - if (list == null) { - list = new TransformerList(); - this.transformerSpool.put(type, list); - if (webAdapterServlet.isDebugMode(null)) { - Log.info("Created new type: " + type); - } - } - - } - transformersInUse++; - return t; - } - - /** - * Recycle a used transformer back to spool. One must guarantee not to use - * the transformer after it have been released. - * - * @param transformer - * the UIDLTransformer to be recycled. - */ - public synchronized void releaseTransformer(UIDLTransformer transformer) { - - try { - // Resets the transformer before returning it to spool - transformer.reset(); - - // Recycle the transformer back to spool - TransformerList list = (TransformerList) this.transformerSpool - .get(transformer.getTransformerType()); - if (list != null) { - list.add(transformer); - if (webAdapterServlet.isDebugMode(null)) { - Log.info("Released transformer: " - + transformer.getTransformerType() + "(In use: " - + transformersInUse + ",Spooled: " + list.size() - + ")"); - } - list.lastUsed = System.currentTimeMillis(); - } else { - Log.info("Tried to release non-existing transformer. Ignoring." - + " (Type:" + transformer.getTransformerType() + ")"); - } - } finally { - if (transformersInUse > 0) - transformersInUse--; - notifyAll(); - } - } - - /** - * - * - * - */ - private class TransformerList { - - private LinkedList list = new LinkedList(); - - private long lastUsed = 0; - - /** - * - * @param transformer - */ - public void add(UIDLTransformer transformer) { - list.add(transformer); - } - - /** - * - * @return - */ - public UIDLTransformer removeFirst() { - return (UIDLTransformer) ((LinkedList) list).removeFirst(); - } - - /** - * - * @return - */ - public boolean isEmpty() { - return list.isEmpty(); - } - - /** - * - * @return - */ - public int size() { - return list.size(); - } - } - - /** - * - * - */ - private synchronized void removeUnusedTransformers() { - long currentTime = System.currentTimeMillis(); - HashSet keys = new HashSet(); - keys.addAll(this.transformerSpool.keySet()); - for (Iterator i = keys.iterator(); i.hasNext();) { - UIDLTransformerType type = (UIDLTransformerType) i.next(); - TransformerList l = (TransformerList) this.transformerSpool - .get(type); - if (l != null) { - if (l.lastUsed > 0 - && l.lastUsed < (currentTime - this.cacheTime)) { - if (webAdapterServlet.isDebugMode(null)) { - Log.info("Removed transformer: " + type - + " Not used since " + new Date(l.lastUsed)); - } - this.transformerSpool.remove(type); - } - } - } - } - - /** - * Class for periodically remove unused transformers from memory. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - protected class SpoolManager extends Thread { - - long refreshTime; - - /** - * - * @param refreshTime - */ - public SpoolManager(long refreshTime) { - super("UIDLTransformerFactory.SpoolManager"); - this.refreshTime = refreshTime; - } - - /** - * - * @see java.lang.Thread#run() - */ - public void run() { - while (true) { - try { - sleep(refreshTime); - } catch (Exception e) { - } - removeUnusedTransformers(); - } - } - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/UIDLTransformerType.java b/src/com/itmill/toolkit/terminal/web/UIDLTransformerType.java deleted file mode 100644 index 33ef3762a4..0000000000 --- a/src/com/itmill/toolkit/terminal/web/UIDLTransformerType.java +++ /dev/null @@ -1,120 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -/** - * Type of the transformer. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public class UIDLTransformerType { - - /** - * Holds the value of property webBrowserType. - */ - private WebBrowser webBrowser; - - /** - * Holds the value of property theme. - */ - private Theme theme; - - /** - * Creates a new instance of TransformerType. - * - * @param webBrowserType - * the web browser type. - * @param theme - * the property theme. - */ - public UIDLTransformerType(WebBrowser webBrowserType, Theme theme) { - if (webBrowserType == null || theme == null) - throw new IllegalArgumentException( - "WebBrowserType and Theme must be non-null values"); - this.webBrowser = webBrowserType; - this.theme = theme; - } - - /** - * Returns the hash code for this string. - * - * @return the hash code value. - */ - public int hashCode() { - - return this.toString().hashCode(); - } - - /** - * Gets the web browser type used in the UIDLTransformer of this type. - * - * @return the Web browser type used. - */ - public WebBrowser getWebBrowser() { - return this.webBrowser; - } - - /** - * Gets the theme used in the UIDLTransformer of this type. - * - * @return the Theme used. - */ - public Theme getTheme() { - return this.theme; - } - - /** - * Two types are equal, if their properties are equal. - * - * @see java.lang.Object#equals(java.lang.Object) - */ - public boolean equals(Object obj) { - // Checks that the object are of the same class - if (!(obj.getClass().equals(this.getClass()))) - return false; - - // Checks that the properties of the types are equal - return this.toString().equals(obj.toString()); - } - - /** - * Textual representation of the UIDLTransformer type. - * - * @see java.lang.Object#toString() - */ - public String toString() { - return " theme='" + theme.getName() + "' js=" - + webBrowser.getJavaScriptVersion() + "' markup='" - + webBrowser.getMarkupVersion() + "'"; - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/WebPaintTarget.java b/src/com/itmill/toolkit/terminal/web/WebPaintTarget.java deleted file mode 100644 index 3b8564a703..0000000000 --- a/src/com/itmill/toolkit/terminal/web/WebPaintTarget.java +++ /dev/null @@ -1,734 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import com.itmill.toolkit.Application; -import com.itmill.toolkit.terminal.ApplicationResource; -import com.itmill.toolkit.terminal.ExternalResource; -import com.itmill.toolkit.terminal.PaintException; -import com.itmill.toolkit.terminal.PaintTarget; -import com.itmill.toolkit.terminal.Paintable; -import com.itmill.toolkit.terminal.Resource; -import com.itmill.toolkit.terminal.ThemeResource; -import com.itmill.toolkit.terminal.UploadStream; -import com.itmill.toolkit.terminal.VariableOwner; - -import java.util.Stack; - -/** - * User Interface Description Language Target. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ -public class WebPaintTarget implements PaintTarget { - - /* Document type declarations */ - private final static String UIDL_XML_DECL = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"; - - /* commonly used tags and argument names */ - private final static String UIDL_ARG_NAME = "name"; - - private final static String UIDL_ARG_VALUE = "value"; - - private final static String UIDL_ARG_ID = "id"; - - private Stack mOpenTags; - - private boolean mTagArgumentListOpen; - - private StringBuffer uidlBuffer; - - private StringBuffer tagBuffer; - - private HttpVariableMap variableMap; - - private boolean closed = false; - - private ApplicationServlet webAdapterServlet; - - private Theme theme; - - private static final int TAG_BUFFER_DEFAULT_SIZE = 20; - - private boolean mSuppressOutput = false; - - /** - * Creates a new XMLPrintWriter, without automatic line flushing. - * - * @param out - * A character-output stream. - */ - public WebPaintTarget(HttpVariableMap variableMap, - UIDLTransformerType type, ApplicationServlet webAdapterServlet, - Theme theme) throws PaintException { - - // Host servlet - this.webAdapterServlet = webAdapterServlet; - - // Target theme - this.theme = theme; - - // Sets the variable map - this.variableMap = variableMap; - - // Sets the target for UIDL writing - this.uidlBuffer = new StringBuffer(); - - // Sets the target for TAG data - this.tagBuffer = new StringBuffer(); - - // Initialize tag-writing - mOpenTags = new Stack(); - mTagArgumentListOpen = false; - - // Adds document declaration - this.print(UIDL_XML_DECL + "\n\n"); - - // Adds UIDL start tag and its attributes - this.startTag("uidl"); - - // Name of the active theme - this.addAttribute("theme", type.getTheme().getName()); - - } - - /** - * Ensures that the currently open element tag is closed. - */ - private void ensureClosedTag() { - if (mTagArgumentListOpen) { - tagBuffer.append(">"); - mTagArgumentListOpen = false; - append(tagBuffer); - } - } - - /** - * Prints element start tag. - * - * <pre> - * Todo: - * Checking of input values - * </pre> - * - * @param tagName - * the name of the start tag. - * @throws PaintException - * if the paint operation failed. - * - */ - public void startTag(String tagName) throws PaintException { - // In case of null data output nothing: - if (tagName == null) - throw new NullPointerException(); - - // Ensure that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - // Make sure that the open start tag is closed before - // anything is written. - ensureClosedTag(); - - // Check tagName and attributes here - mOpenTags.push(tagName); - tagBuffer = new StringBuffer(TAG_BUFFER_DEFAULT_SIZE); - - // Print the tag with attributes - tagBuffer.append("<" + tagName); - - mTagArgumentListOpen = true; - } - - /** - * Prints element end tag. - * - * If the parent tag is closed before every child tag is closed a - * PaintException is raised. - * - * @param tagName - * the name of the end tag. - * @throws PaintException - * if the paint operation failed. - */ - public void endTag(String tagName) throws PaintException { - // In case of null data output nothing: - if (tagName == null) - throw new NullPointerException(); - - // Ensures that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - String lastTag = ""; - - lastTag = (String) mOpenTags.pop(); - if (!tagName.equalsIgnoreCase(lastTag)) - throw new PaintException("Invalid UIDL: wrong ending tag: '" - + tagName + "' expected: '" + lastTag + "'."); - - // Makes sure that the open start tag is closed before - // anything is written. - ensureClosedTag(); - - // Writes the end (closing) tag - append("</" + lastTag + "\n>"); - - // NOTE: We re-enable the output (if it has been disabled) - // for subsequent tags. The output is suppressed if tag - // contains attribute "invisible" with value true. - mSuppressOutput = false; - } - - /** - * Appends data into UIDL output buffer. - * - * @param data - * the String to be appended. - */ - private void append(String data) { - if (!mSuppressOutput) { - uidlBuffer.append(data); - } - } - - /** - * Appends data into UIDL output buffer. - * - * @param data - * the StringBuffer to be appended. - */ - private void append(StringBuffer data) { - if (!mSuppressOutput) { - uidlBuffer.append(data); - } - } - - /** - * Substitutes the XML sensitive characters with predefined XML entities. - * - * @param xml - * @return A new string instance where all occurrences of XML sensitive - * characters are substituted with entities. - */ - static public String escapeXML(String xml) { - if (xml == null || xml.length() <= 0) - return ""; - return escapeXML(new StringBuffer(xml)).toString(); - } - - /** - * Substitutes the XML sensitive characters with predefined XML entities. - * - * @param xml - * the String to be substituted. - * @return A new StringBuffer instance where all occurrences of XML - * sensitive characters are substituted with entities. - * - */ - static public StringBuffer escapeXML(StringBuffer xml) { - if (xml == null || xml.length() <= 0) - return new StringBuffer(""); - - StringBuffer result = new StringBuffer(xml.length() * 2); - - for (int i = 0; i < xml.length(); i++) { - char c = xml.charAt(i); - String s = toXmlChar(c); - if (s != null) { - result.append(s); - } else { - result.append(c); - } - } - return result; - } - - /** - * Substitutes a XML sensitive character with predefined XML entity. - * - * @param c - * the Character to be replaced with an entity. - * @return String of the entity or null if character is not to be replaced - * with an entity. - */ - private static String toXmlChar(char c) { - switch (c) { - case '&': - return "&"; // & => & - case '>': - return ">"; // > => > - case '<': - return "<"; // < => < - case '"': - return """; // " => " - case '\'': - return "'"; // ' => ' - default: - return null; - } - } - - /** - * Prints XML. - * - * Writes pre-formatted XML to stream. Well-formness of XML is checked. - * - * <pre> - * TODO: XML checking should be made - * </pre> - * - * @param str - */ - private void print(String str) { - // In case of null data output nothing: - if (str == null) - return; - - // Make sure that the open start tag is closed before - // anything is written. - ensureClosedTag(); - - // Write what was given - append(str); - } - - /** - * Prints XML-escaped text. - * - * @param str - * @throws PaintException - * if the paint operation failed. - * - */ - public void addText(String str) throws PaintException { - addUIDL(escapeXML(str)); - } - - /** - * Adds a boolean attribute to component. Atributes must be added before any - * content is written. - * - * @param name - * the Attribute name. - * @param value - * the Attribute value. - * @throws PaintException - * if the paint operation failed. - */ - public void addAttribute(String name, boolean value) throws PaintException { - if ("invisible".equals(name) && value) { - // NOTE: If we receive the "invisible attribute - // we filter these tags (and ceontent) from - // them out from the output. - this.mSuppressOutput = true; - } else { - addAttribute(name, String.valueOf(value)); - } - } - - /** - * Adds a resource attribute to component. Atributes must be added before - * any content is written. - * - * @param name - * the Attribute name. - * @param value - * the Attribute value. - * @throws PaintException - * if the paint operation failed. - */ - public void addAttribute(String name, Resource value) throws PaintException { - - if (value instanceof ExternalResource) { - addAttribute(name, ((ExternalResource) value).getURL()); - - } else if (value instanceof ApplicationResource) { - ApplicationResource r = (ApplicationResource) value; - Application a = r.getApplication(); - if (a == null) - throw new PaintException( - "Application not specified for resorce " - + value.getClass().getName()); - String uri = a.getURL().getPath(); - if (uri.charAt(uri.length() - 1) != '/') - uri += "/"; - uri += a.getRelativeLocation(r); - addAttribute(name, uri); - - } else if (value instanceof ThemeResource) { - addAttribute(name, webAdapterServlet.getResourceLocation(theme - .getName(), (ThemeResource) value)); - } else - throw new PaintException("Web adapter does not " - + "support resources of type: " - + value.getClass().getName()); - - } - - /** - * Adds a integer attribute to component. Atributes must be added before any - * content is written. - * - * @param name - * the Attribute name. - * @param value - * the Attribute value. - * @throws PaintException - * if the paint operation failed. - */ - public void addAttribute(String name, int value) throws PaintException { - addAttribute(name, String.valueOf(value)); - } - - /** - * Adds a long attribute to component. Atributes must be added before any - * content is written. - * - * @param name - * the Attribute name. - * @param value - * the Attribute value. - * @throws PaintException - * if the paint operation failed. - */ - public void addAttribute(String name, long value) throws PaintException { - addAttribute(name, String.valueOf(value)); - } - - /** - * Adds a string attribute to component. Atributes must be added before any - * content is written. - * - * @param name - * the Boolean attribute name. - * @param value - * the Boolean attribute value. - * @throws PaintException - * if the paint operation failed. - */ - public void addAttribute(String name, String value) throws PaintException { - // In case of null data output nothing: - if ((value == null) || (name == null)) - throw new NullPointerException( - "Parameters must be non-null strings (" + name + "=" - + value + ")"); - - // Ensure that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - // Check that argument list is writable. - if (!mTagArgumentListOpen) - throw new PaintException("XML argument list not open."); - - tagBuffer.append(" " + name + "=\"" + escapeXML(value) + "\""); - } - - /** - * Adds a string type variable. - * - * @param owner - * the Listener for variable changes. - * @param name - * the Variable name. - * @param value - * the Variable initial value. - * @throws PaintException - * if the paint operation failed. - */ - public void addVariable(VariableOwner owner, String name, String value) - throws PaintException { - String code = variableMap.registerVariable(name, String.class, value, - owner); - startTag("string"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - addText(value); - endTag("string"); - } - - /** - * Adds a int type variable. - * - * @param owner - * the Listener for variable changes. - * @param name - * the Variable name. - * @param value - * the Variable initial value. - * @throws PaintException - * if the paint operation failed. - */ - public void addVariable(VariableOwner owner, String name, int value) - throws PaintException { - String code = variableMap.registerVariable(name, Integer.class, - new Integer(value), owner); - startTag("integer"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - addAttribute(UIDL_ARG_VALUE, String.valueOf(value)); - endTag("integer"); - } - - /** - * Adds a boolean type variable. - * - * @param owner - * the Listener for variable changes. - * @param name - * the Variable name. - * @param value - * the Variable initial value. - * @throws PaintException - * if the paint operation failed. - */ - public void addVariable(VariableOwner owner, String name, boolean value) - throws PaintException { - String code = variableMap.registerVariable(name, Boolean.class, - new Boolean(value), owner); - startTag("boolean"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - addAttribute(UIDL_ARG_VALUE, String.valueOf(value)); - endTag("boolean"); - } - - /** - * Adds a string array type variable. - * - * @param owner - * the Listener for variable changes. - * @param name - * the Variable name. - * @param value - * the Variable initial value. - * @throws PaintException - * if the paint operation failed. - */ - public void addVariable(VariableOwner owner, String name, Object[] value) - throws PaintException { - String code = variableMap.registerVariable(name, String[].class, value, - owner); - startTag("array"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - for (int i = 0; i < value.length; i++) - addSection("ai", (String) value[i]); - endTag("array"); - } - - /** - * Adds a upload stream type variable. - * - * @param owner - * the Listener for variable changes. - * @param name - * the Variable name. - * - * @throws PaintException - * if the paint operation failed. - */ - public void addUploadStreamVariable(VariableOwner owner, String name) - throws PaintException { - String code = variableMap.registerVariable(name, UploadStream.class, - null, owner); - startTag("uploadstream"); - addAttribute(UIDL_ARG_ID, code); - addAttribute(UIDL_ARG_NAME, name); - endTag("uploadstream"); - } - - /** - * Prints the single text section. - * <p> - * Prints full text section. The section data is escaped from XML tags and - * surrounded by XML start and end-tags. - * </p> - * - * @param sectionTagName - * the name of the tag. - * @param sectionData - * the section data. - * @throws PaintException - * if the paint operation failed. - */ - public void addSection(String sectionTagName, String sectionData) - throws PaintException { - startTag(sectionTagName); - addText(sectionData); - endTag(sectionTagName); - } - - /** - * Adds XML directly to UIDL. - * - * @param xml - * the XML to be added. - * @throws PaintException - * if the paint operation failed. - */ - public void addUIDL(String xml) throws PaintException { - - // Ensure that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - // Make sure that the open start tag is closed before - // anything is written. - ensureClosedTag(); - - // Escape and write what was given - if (xml != null) - append(xml); - - } - - /** - * Adds XML section with namespace. - * - * @see com.itmill.toolkit.terminal.PaintTarget#addXMLSection(String, - * String, String) - */ - public void addXMLSection(String sectionTagName, String sectionData, - String namespace) throws PaintException { - - // Ensures that the target is open - if (this.closed) - throw new PaintException( - "Attempted to write to a closed PaintTarget."); - - startTag(sectionTagName); - if (namespace != null) - addAttribute("xmlns", namespace); - - // Closes that starting tag - ensureClosedTag(); - - if (sectionData != null) - append(sectionData); - endTag(sectionTagName); - } - - /** - * Gets the UIDL already printed to stream. Paint target must be closed - * before the <code>getUIDL</code> can be called. - * - * @return the UIDL. - */ - public String getUIDL() { - if (this.closed) { - return uidlBuffer.toString(); - } - throw new IllegalStateException( - "Tried to read UIDL from open PaintTarget"); - } - - /** - * Closes the paint target. Paint target must be closed before the - * <code>getUIDL</code> can be called. Subsequent attempts to write to - * paint target. If the target was already closed, call to this function is - * ignored. will generate an exception. - * - * @throws PaintException - * if the paint operation failed. - */ - public void close() throws PaintException { - if (!this.closed) { - this.endTag("uidl"); - this.closed = true; - } - } - - /** - * Prints element start tag of a paintable section. Starts a paintable - * section using the given tag. The PaintTarget may implement a caching - * scheme, that checks the paintable has actually changed or can a cached - * version be used instead. This method should call the startTag method. - * <p> - * If the Paintable is found in cache and this function returns true it may - * omit the content and close the tag, in which case cached content should - * be used. - * </p> - * <b>Note:</b> Web adapter does not currently implement caching and this - * function always returns false. - * - * @param paintable - * the paintable to start. - * @param tag - * the name of the start tag. - * @return false - * @throws PaintException - * if the paint operation failed. - * @see com.itmill.toolkit.terminal.PaintTarget#startTag(Paintable, String), - * #startTag(String) - * @since 3.1 - */ - public boolean startTag(Paintable paintable, String tag) - throws PaintException { - startTag(tag); - return false; - } - - /** - * Adds CDATA node to target UIDL-tree. - * - * @param text - * the Character data to add. - * @throws PaintException - * if the paint operation failed. - * @since 3.1 - */ - public void addCharacterData(String text) throws PaintException { - addUIDL("<![CDATA[" + text + "]]>"); - } - - public void addAttribute(String string, String[] keys) { - // TODO Auto-generated method stub - - } - - public void addAttribute(String string, Object[] keys) { - // TODO Auto-generated method stub - - } - - public void addVariable(VariableOwner owner, String name, String[] value) throws PaintException { - // TODO Auto-generated method stub - - } - -} diff --git a/src/com/itmill/toolkit/terminal/web/XSLReader.java b/src/com/itmill/toolkit/terminal/web/XSLReader.java deleted file mode 100644 index 483bd73572..0000000000 --- a/src/com/itmill/toolkit/terminal/web/XSLReader.java +++ /dev/null @@ -1,590 +0,0 @@ -/* ************************************************************************* - - IT Mill Toolkit - - Development of Browser User Interfaces Made Easy - - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* - - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html - - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com - - ********************************************************************** */ - -package com.itmill.toolkit.terminal.web; - -import java.io.IOException; -import java.io.InputStream; -import java.util.Collection; -import java.util.Iterator; - -import org.xml.sax.Attributes; -import org.xml.sax.ContentHandler; -import org.xml.sax.DTDHandler; -import org.xml.sax.EntityResolver; -import org.xml.sax.ErrorHandler; -import org.xml.sax.InputSource; -import org.xml.sax.Locator; -import org.xml.sax.SAXException; -import org.xml.sax.SAXNotRecognizedException; -import org.xml.sax.SAXNotSupportedException; -import org.xml.sax.SAXParseException; -import org.xml.sax.XMLReader; - -/** - * Class implementing XMLReader for the UIDLTransformer. - * - * @author IT Mill Ltd. - * @version - * @VERSION@ - * @since 3.0 - */ - -public class XSLReader implements XMLReader, ContentHandler { - - static protected final int XSLT_UNKNOWN = 0; - - static protected final int XSLT_XALAN = 1; - - static protected final int XSLT_SAXON6 = 2; - - static protected final int XSLT_SAXON7 = 3; - - static protected final int XSLT_RESIN = 4; - - static protected final int XSLT_WEBLOGIC = 5; - - static protected int xsltProcessor = XSLT_UNKNOWN; - static { - String transformerName = UIDLTransformer.xsltFactory.getClass() - .getName(); - - // Saxon 7.x - if ("net.sf.saxon.TransformerFactoryImpl".equals(transformerName)) - xsltProcessor = XSLT_SAXON7; - - // Saxon 6.x - else if ("com.icl.saxon.TransformerFactoryImpl".equals(transformerName)) - xsltProcessor = XSLT_SAXON6; - - // Xalan - else if ("org.apache.xalan.processor.TransformerFactoryImpl" - .equals(transformerName) - || "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl" - .equals(transformerName)) - xsltProcessor = XSLT_XALAN; - // Resin - else if ("com.caucho.xsl.Xsl".equals(transformerName)) - xsltProcessor = XSLT_RESIN; - - else if ("weblogic.xml.jaxp.RegistrySAXTransformerFactory" - .equals(transformerName)) - xsltProcessor = XSLT_WEBLOGIC; - else { - throw new RuntimeException( - "\nThis version of IT Mill Toolkit " - + " does not support the selected XSLT-processer:\n " - + transformerName - + "\n" - + "You can specify the used XSLT processor with JVM " - + "parameter like: \n" - + " -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl\n" - + " -Dorg.xml.sax.driver=org.apache.crimson.parser.XMLReaderImpl\n"); - } - } - - private static final String[] JAVA_PREFIX = { "java://", "millstone://" }; - - private Collection streams; - - private boolean startTagHandled = false; - - private String xslNamespace = ""; - - private ContentHandler handler; - - private XMLReader reader; - - private XSLStreamLocator locator = null; - - private Locator streamLocator = null; - - private int streamStartLineNumber = 0; - - public XSLReader(XMLReader reader, Collection streams) { - this.reader = reader; - reader.setContentHandler(this); - this.streams = streams; - } - - /** - * Parses all streams given for constructor parameter. The input parameter - * is ignored. - * - * @see org.xml.sax.XMLReader#parse(InputSource) - */ - public synchronized void parse(InputSource input) throws IOException, - SAXException { - - startTagHandled = false; - handler.startDocument(); - // Parse all files - for (Iterator i = streams.iterator(); i.hasNext();) { - ThemeSource.XSLStream xslStream = (ThemeSource.XSLStream) i.next(); - this.locator = new XSLStreamLocator(xslStream.getId()); - InputStream in = (xslStream).getStream(); - - // Parse the stream - reader.parse(new InputSource(in)); - - } - handler.endElement(xslNamespace, "stylesheet", "xsl:stylesheet"); - handler.endDocument(); - } - - /** - * @see org.xml.sax.ContentHandler#endElement(String, String, String) - */ - public void endElement(String namespaceURI, String localName, String qName) - throws SAXException { - if (localName.equals("stylesheet")) { - return; // Skip - } - handler.endElement(namespaceURI, localName, qName); - } - - /** - * @see org.xml.sax.ContentHandler#processingInstruction(String, String) - */ - public void processingInstruction(String target, String data) - throws SAXException { - handler.processingInstruction(target, data); - } - - /** - * @see org.xml.sax.ContentHandler#startElement(String, String, String, - * Attributes) - */ - public void startElement(String namespaceURI, String localName, - String qName, Attributes atts) throws SAXException { - - // Only the first stylesheet is used - if (startTagHandled && localName.equals("stylesheet")) - return; // skip - - // Get the namespace that will be used for closing the theme - if (localName.equals("stylesheet")) { - startTagHandled = true; - this.xslNamespace = namespaceURI; - - // Manage calls to external functions in XSLT-processor independent - // way, but still using XSLT 1.0 - handler.startElement(namespaceURI, localName, qName, - new AttributeMapper(atts)); - } else - - // Handle the element in superclass directly - handler.startElement(namespaceURI, localName, qName, atts); - } - - /** - * @see org.xml.sax.ContentHandler#characters(char[], int, int) - */ - public void characters(char[] ch, int start, int length) - throws SAXException { - handler.characters(ch, start, length); - } - - /** - * @see org.xml.sax.ContentHandler#startDocument() - */ - public void startDocument() throws SAXException { - // Ignore document starts - } - - /** - * @see org.xml.sax.ContentHandler#endDocument() - */ - public void endDocument() throws SAXException { - // Ignore document ends, but add previous line numbers - if (this.streamLocator != null) { - this.streamStartLineNumber += this.streamLocator.getLineNumber(); - } - } - - /** - * @see org.xml.sax.ContentHandler#endPrefixMapping(String) - */ - public void endPrefixMapping(String prefix) throws SAXException { - handler.endPrefixMapping(prefix); - } - - /** - * @see org.xml.sax.ContentHandler#ignorableWhitespace(char[], int, int) - */ - public void ignorableWhitespace(char[] ch, int start, int length) - throws SAXException { - handler.ignorableWhitespace(ch, start, length); - } - - /** - * @see org.xml.sax.ContentHandler#setDocumentLocator(Locator) - */ - public void setDocumentLocator(Locator locator) { - this.streamLocator = locator; - // create new locator combined streams/files - if (!startTagHandled) { - handler.setDocumentLocator(this.locator); - } - } - - /** - * @see org.xml.sax.ContentHandler#skippedEntity(String) - */ - public void skippedEntity(String name) throws SAXException { - handler.skippedEntity(name); - } - - /** - * @see org.xml.sax.ContentHandler#startPrefixMapping(String, String) - */ - public void startPrefixMapping(String prefix, String uri) - throws SAXException { - handler.startPrefixMapping(prefix, uri); - } - - /** - * Overrides the default content handler. - * - * @see org.xml.sax.XMLReader#getContentHandler() - */ - public ContentHandler getContentHandler() { - return this.handler; - } - - /** - * Overrides the default content handler. - * - * @see org.xml.sax.XMLReader#setContentHandler(ContentHandler) - */ - public void setContentHandler(ContentHandler handler) { - this.handler = handler; - } - - /** - * @see org.xml.sax.XMLReader#getDTDHandler() - */ - public DTDHandler getDTDHandler() { - return reader.getDTDHandler(); - } - - /** - * @see org.xml.sax.XMLReader#getEntityResolver() - */ - public EntityResolver getEntityResolver() { - return reader.getEntityResolver(); - } - - /** - * @see org.xml.sax.XMLReader#getErrorHandler() - */ - public ErrorHandler getErrorHandler() { - return reader.getErrorHandler(); - } - - /** - * @see org.xml.sax.XMLReader#getFeature(String) - */ - public boolean getFeature(String name) throws SAXNotRecognizedException, - SAXNotSupportedException { - return reader.getFeature(name); - } - - /** - * @see org.xml.sax.XMLReader#getProperty(String) - */ - public Object getProperty(String name) throws SAXNotRecognizedException, - SAXNotSupportedException { - return reader.getProperty(name); - } - - /** - * Overrides the parse. - * - * @see org.xml.sax.XMLReader#parse(String) - */ - public void parse(String systemId) throws IOException, SAXException { - this.parse((InputSource) null); - } - - /** - * @see org.xml.sax.XMLReader#setDTDHandler(DTDHandler) - */ - public void setDTDHandler(DTDHandler handler) { - reader.setDTDHandler(handler); - } - - /** - * @see org.xml.sax.XMLReader#setEntityResolver(EntityResolver) - */ - public void setEntityResolver(EntityResolver resolver) { - reader.setEntityResolver(resolver); - } - - /** - * @see org.xml.sax.XMLReader#setErrorHandler(ErrorHandler) - */ - public void setErrorHandler(ErrorHandler handler) { - reader.setErrorHandler(new SAXStreamErrorHandler(handler)); - } - - /** - * @see org.xml.sax.XMLReader#setFeature(String, boolean) - */ - public void setFeature(String name, boolean value) - throws SAXNotRecognizedException, SAXNotSupportedException { - reader.setFeature(name, value); - } - - /** - * @see org.xml.sax.XMLReader#setProperty(String, Object) - */ - public void setProperty(String name, Object value) - throws SAXNotRecognizedException, SAXNotSupportedException { - reader.setProperty(name, value); - } - - public class AttributeMapper implements Attributes { - - private Attributes original; - - /** - * - * @param originalAttributes - */ - public AttributeMapper(Attributes originalAttributes) { - original = originalAttributes; - } - - /** - * @see org.xml.sax.Attributes#getIndex(String, String) - */ - public int getIndex(String uri, String localName) { - return original.getIndex(uri, localName); - } - - /** - * @see org.xml.sax.Attributes#getIndex(String) - */ - public int getIndex(String qName) { - return original.getIndex(qName); - } - - /** - * @see org.xml.sax.Attributes#getLength() - */ - public int getLength() { - return original.getLength(); - } - - /** - * @see org.xml.sax.Attributes#getLocalName(int) - */ - public String getLocalName(int index) { - return original.getLocalName(index); - } - - /** - * @see org.xml.sax.Attributes#getQName(int) - */ - public String getQName(int index) { - return original.getQName(index); - } - - /** - * @see org.xml.sax.Attributes#getType(int) - */ - public String getType(int index) { - return original.getType(index); - } - - /** - * @see org.xml.sax.Attributes#getType(String, String) - */ - public String getType(String uri, String localName) { - return original.getType(uri, localName); - } - - /** - * @see org.xml.sax.Attributes#getType(String) - */ - public String getType(String qName) { - return original.getType(qName); - } - - /** - * @see org.xml.sax.Attributes#getURI(int) - */ - public String getURI(int index) { - String uri = original.getURI(index); - - for (int i = 0; i < JAVA_PREFIX.length; i++) - if (uri != null && uri.startsWith(JAVA_PREFIX[i])) { - - System.out.print("DEBUG " + uri + " --> "); - switch (xsltProcessor) { - case XSLT_SAXON6: - uri = "saxon://" - + uri.substring(JAVA_PREFIX[i].length()); - break; - case XSLT_SAXON7: - uri = "saxon://" - + uri.substring(JAVA_PREFIX[i].length()); - break; - case XSLT_XALAN: - uri = "xalan://" - + uri.substring(JAVA_PREFIX[i].length()); - break; - default: - uri = "xalan://" - + uri.substring(JAVA_PREFIX[i].length()); - break; - } - System.out.println(uri); - } - - return uri; - } - - /** - * @see org.xml.sax.Attributes#getValue(int) - */ - public String getValue(int index) { - return original.getValue(index); - } - - /** - * @see org.xml.sax.Attributes#getValue(String, String) - */ - public String getValue(String uri, String localName) { - return original.getValue(uri, localName); - } - - /** - * @see org.xml.sax.Attributes#getValue(String) - */ - public String getValue(String qName) { - return original.getValue(qName); - } - } - - public class XSLStreamLocator implements Locator { - - private String id; - - /** - * - * @param id - */ - public XSLStreamLocator(String id) { - this.id = id; - } - - /** - * - * @see org.xml.sax.Locator#getPublicId() - */ - public String getPublicId() { - return streamLocator.getPublicId(); - } - - /** - * - * @see org.xml.sax.Locator#getSystemId() - */ - public String getSystemId() { - return streamLocator.getSystemId() + "" + id; - } - - /** - * - * @see org.xml.sax.Locator#getLineNumber() - */ - public int getLineNumber() { - return streamLocator.getLineNumber(); - } - - public int getCombinedLineNumber() { - return streamLocator.getLineNumber() + streamStartLineNumber; - } - - /** - * @see org.xml.sax.Locator#getColumnNumber() - */ - public int getColumnNumber() { - return streamLocator.getColumnNumber(); - } - - /** - * Gets the id. - * - * @return the id . - */ - public String getId() { - return id; - } - } - - public class SAXStreamErrorHandler implements ErrorHandler { - - private ErrorHandler handler; - - /** - * - * @param origHandler - */ - SAXStreamErrorHandler(ErrorHandler origHandler) { - this.handler = origHandler; - } - - /** - * @see org.xml.sax.ErrorHandler#warning(org.xml.sax.SAXParseException) - */ - public void warning(SAXParseException exception) throws SAXException { - handler.warning(new SAXParseException("" + exception.getMessage() - + " in " + locator.getId(), locator, exception)); - } - - /** - * @see org.xml.sax.ErrorHandler#error(org.xml.sax.SAXParseException) - */ - public void error(SAXParseException exception) throws SAXException { - handler.error(new SAXParseException("" + exception.getMessage() - + " in " + locator.getId(), locator, exception)); - } - - /** - * @see org.xml.sax.ErrorHandler#fatalError(org.xml.sax.SAXParseException) - */ - public void fatalError(SAXParseException exception) throws SAXException { - handler.fatalError(new SAXParseException("" - + exception.getMessage() + " in " + locator.getId(), - locator, exception)); - } - } -} diff --git a/src/com/itmill/toolkit/terminal/web/package.html b/src/com/itmill/toolkit/terminal/web/package.html deleted file mode 100644 index 774ad5f5af..0000000000 --- a/src/com/itmill/toolkit/terminal/web/package.html +++ /dev/null @@ -1,20 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> - -</head> - -<body bgcolor="white"> - -<!-- Package summary here --> - -<p>This package implement web terminal for both AJAX-capable and more limited web browsers.</p> - -<h2>Package Specification</h2> - -<!-- Package spec here --> - -<!-- Put @see and @since tags down here. --> - -</body> -</html> |