123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624 |
- /*
- @VaadinApache2LicenseForJavaFiles@
- */
- package com.vaadin.terminal.gwt.client;
-
- import java.util.ArrayList;
- import java.util.HashMap;
- import java.util.LinkedList;
- import java.util.List;
-
- import com.google.gwt.core.client.EntryPoint;
- import com.google.gwt.core.client.GWT;
- import com.google.gwt.core.client.GWT.UncaughtExceptionHandler;
- import com.google.gwt.core.client.JavaScriptObject;
- import com.google.gwt.core.client.JsArrayString;
- import com.google.gwt.core.client.Scheduler;
- import com.google.gwt.core.client.Scheduler.ScheduledCommand;
- import com.google.gwt.user.client.Command;
- import com.google.gwt.user.client.Timer;
- import com.vaadin.terminal.gwt.client.ui.VUnknownComponent;
-
- public class ApplicationConfiguration implements EntryPoint {
-
- /**
- * Helper class for reading configuration options from the bootstap
- * javascript
- *
- * @since 7.0
- */
- private static class JsoConfiguration extends JavaScriptObject {
- protected JsoConfiguration() {
- // JSO Constructor
- }
-
- /**
- * Reads a configuration parameter as a string. Please note that the
- * javascript value of the parameter should also be a string, or else an
- * undefined exception may be thrown.
- *
- * @param name
- * name of the configuration parameter
- * @return value of the configuration parameter, or <code>null</code> if
- * not defined
- */
- private native String getConfigString(String name)
- /*-{
- var value = this.getConfig(name);
- if (value === null || value === undefined) {
- return null;
- } else {
- return value +"";
- }
- }-*/;
-
- /**
- * Reads a configuration parameter as a boolean object. Please note that
- * the javascript value of the parameter should also be a boolean, or
- * else an undefined exception may be thrown.
- *
- * @param name
- * name of the configuration parameter
- * @return boolean value of the configuration paramter, or
- * <code>null</code> if no value is defined
- */
- private native Boolean getConfigBoolean(String name)
- /*-{
- var value = this.getConfig(name);
- if (value === null || value === undefined) {
- return null;
- } else {
- return @java.lang.Boolean::valueOf(Z)(value);
- }
- }-*/;
-
- /**
- * Reads a configuration parameter as an integer object. Please note
- * that the javascript value of the parameter should also be an integer,
- * or else an undefined exception may be thrown.
- *
- * @param name
- * name of the configuration parameter
- * @return integer value of the configuration paramter, or
- * <code>null</code> if no value is defined
- */
- private native Integer getConfigInteger(String name)
- /*-{
- var value = this.getConfig(name);
- if (value === null || value === undefined) {
- return null;
- } else {
- return @java.lang.Integer::valueOf(I)(value);
- }
- }-*/;
-
- /**
- * Reads a configuration parameter as an {@link ErrorMessage} object.
- * Please note that the javascript value of the parameter should also be
- * an object with appropriate fields, or else an undefined exception may
- * be thrown when calling this method or when calling methods on the
- * returned object.
- *
- * @param name
- * name of the configuration parameter
- * @return error message with the given name, or <code>null</code> if no
- * value is defined
- */
- private native ErrorMessage getConfigError(String name)
- /*-{
- return this.getConfig(name);
- }-*/;
-
- /**
- * Returns a native javascript object containing version information
- * from the server.
- *
- * @return a javascript object with the version information
- */
- private native JavaScriptObject getVersionInfoJSObject()
- /*-{
- return this.getConfig("versionInfo");
- }-*/;
-
- /**
- * Gets the version of the Vaadin framework used on the server.
- *
- * @return a string with the version
- *
- * @see com.vaadin.terminal.gwt.server.AbstractApplicationServlet#VERSION
- */
- private native String getVaadinVersion()
- /*-{
- return this.getConfig("versionInfo").vaadinVersion;
- }-*/;
-
- /**
- * Gets the version of the application running on the server.
- *
- * @return a string with the application version
- *
- * @see com.vaadin.Application#getVersion()
- */
- private native String getApplicationVersion()
- /*-{
- return this.getConfig("versionInfo").applicationVersion;
- }-*/;
-
- private native String getUIDL()
- /*-{
- return this.getConfig("uidl");
- }-*/;
- }
-
- /**
- * Wraps a native javascript object containing fields for an error message
- *
- * @since 7.0
- */
- public static final class ErrorMessage extends JavaScriptObject {
-
- protected ErrorMessage() {
- // JSO constructor
- }
-
- public final native String getCaption()
- /*-{
- return this.caption;
- }-*/;
-
- public final native String getMessage()
- /*-{
- return this.message;
- }-*/;
-
- public final native String getUrl()
- /*-{
- return this.url;
- }-*/;
- }
-
- /**
- * Builds number. For example 0-custom_tag in 5.0.0-custom_tag.
- */
- public static final String VERSION;
-
- /* Initialize version numbers from string replaced by build-script. */
- static {
- if ("@VERSION@".equals("@" + "VERSION" + "@")) {
- VERSION = "9.9.9.INTERNAL-DEBUG-BUILD";
- } else {
- VERSION = "@VERSION@";
- }
- }
-
- private static WidgetSet widgetSet = GWT.create(WidgetSet.class);
-
- private String id;
- private String themeUri;
- private String appUri;
- private int rootId;
- private boolean standalone;
- private ErrorMessage communicationError;
- private ErrorMessage authorizationError;
- private boolean useDebugIdInDom = true;
- private boolean usePortletURLs = false;
- private String portletUidlURLBase;
-
- private HashMap<String, String> unknownComponents;
-
- private Class<? extends VPaintableWidget>[] classes = new Class[1024];
-
- private String windowId;
-
- private boolean browserDetailsSent = false;
-
- static// TODO consider to make this hashmap per application
- LinkedList<Command> callbacks = new LinkedList<Command>();
-
- private static int widgetsLoading;
-
- private static ArrayList<ApplicationConnection> runningApplications = new ArrayList<ApplicationConnection>();
-
- public boolean usePortletURLs() {
- return usePortletURLs;
- }
-
- public String getPortletUidlURLBase() {
- return portletUidlURLBase;
- }
-
- public String getRootPanelId() {
- return id;
- }
-
- /**
- * Gets the application base URI. Using this other than as the download
- * action URI can cause problems in Portlet 2.0 deployments.
- *
- * @return application base URI
- */
- public String getApplicationUri() {
- return appUri;
- }
-
- public String getThemeUri() {
- return themeUri;
- }
-
- public void setAppId(String appId) {
- id = appId;
- }
-
- /**
- * Gets the initial UIDL from the DOM, if it was provided during the init
- * process.
- *
- * @return
- */
- public String getUIDL() {
- return getJsoConfiguration(id).getUIDL();
- }
-
- /**
- * @return true if the application is served by std. Vaadin servlet and is
- * considered to be the only or main content of the host page.
- */
- public boolean isStandalone() {
- return standalone;
- }
-
- /**
- * Gets the root if of this application instance. The root id should be
- * included in every request originating from this instance in order to
- * associate it with the right Root instance on the server.
- *
- * @return the root id
- */
- public int getRootId() {
- return rootId;
- }
-
- public JavaScriptObject getVersionInfoJSObject() {
- return getJsoConfiguration(id).getVersionInfoJSObject();
- }
-
- public ErrorMessage getCommunicationError() {
- return communicationError;
- }
-
- public ErrorMessage getAuthorizationError() {
- return authorizationError;
- }
-
- /**
- * Reads the configuration values defined by the bootstrap javascript.
- */
- private void loadFromDOM() {
- JsoConfiguration jsoConfiguration = getJsoConfiguration(id);
- appUri = jsoConfiguration.getConfigString("appUri");
- if (appUri != null && !appUri.endsWith("/")) {
- appUri += '/';
- }
- themeUri = jsoConfiguration.getConfigString("themeUri");
- rootId = jsoConfiguration.getConfigInteger("rootId").intValue();
-
- // null -> true
- useDebugIdInDom = jsoConfiguration.getConfigBoolean("useDebugIdInDom") != Boolean.FALSE;
-
- // null -> false
- usePortletURLs = jsoConfiguration.getConfigBoolean("usePortletURLs") == Boolean.TRUE;
-
- portletUidlURLBase = jsoConfiguration
- .getConfigString("portletUidlURLBase");
-
- // null -> false
- standalone = jsoConfiguration.getConfigBoolean("standalone") == Boolean.TRUE;
-
- communicationError = jsoConfiguration.getConfigError("comErrMsg");
- authorizationError = jsoConfiguration.getConfigError("authErrMsg");
-
- // boostrap sets initPending to false if it has sent the browser details
- if (jsoConfiguration.getConfigBoolean("initPending") == Boolean.FALSE) {
- setBrowserDetailsSent();
- }
-
- }
-
- /**
- * Starts the application with a given id by reading the configuration
- * options stored by the bootstrap javascript.
- *
- * @param applicationId
- * id of the application to load, this is also the id of the html
- * element into which the application should be rendered.
- */
- public static void startApplication(final String applicationId) {
- Scheduler.get().scheduleDeferred(new ScheduledCommand() {
- public void execute() {
- ApplicationConfiguration appConf = getConfigFromDOM(applicationId);
- ApplicationConnection a = GWT
- .create(ApplicationConnection.class);
- a.init(widgetSet, appConf);
- a.start();
- runningApplications.add(a);
- }
- });
- }
-
- public static List<ApplicationConnection> getRunningApplications() {
- return runningApplications;
- }
-
- /**
- * Gets the configuration object for a specific application from the
- * bootstrap javascript.
- *
- * @param appId
- * the id of the application to get configuration data for
- * @return a native javascript object containing the configuration data
- */
- private native static JsoConfiguration getJsoConfiguration(String appId)
- /*-{
- return $wnd.vaadin.getApp(appId);
- }-*/;
-
- public static ApplicationConfiguration getConfigFromDOM(String appId) {
- ApplicationConfiguration conf = new ApplicationConfiguration();
- conf.setAppId(appId);
- conf.loadFromDOM();
- return conf;
- }
-
- public String getServletVersion() {
- return getJsoConfiguration(id).getVaadinVersion();
- }
-
- public String getApplicationVersion() {
- return getJsoConfiguration(id).getApplicationVersion();
- }
-
- public boolean useDebugIdInDOM() {
- return useDebugIdInDom;
- }
-
- public Class<? extends VPaintableWidget> getWidgetClassByEncodedTag(String tag) {
- try {
- int parseInt = Integer.parseInt(tag);
- return classes[parseInt];
- } catch (Exception e) {
- // component was not present in mappings
- return VUnknownComponent.class;
- }
- }
-
- public void addComponentMappings(ValueMap valueMap, WidgetSet widgetSet) {
- JsArrayString keyArray = valueMap.getKeyArray();
- for (int i = 0; i < keyArray.length(); i++) {
- String key = keyArray.get(i).intern();
- int value = valueMap.getInt(key);
- classes[value] = widgetSet.getImplementationByClassName(key);
- if (classes[value] == VUnknownComponent.class) {
- if (unknownComponents == null) {
- unknownComponents = new HashMap<String, String>();
- }
- unknownComponents.put("" + value, key);
- } else if (key == "com.vaadin.ui.Root") {
- windowId = "" + value;
- }
- }
- }
-
- /**
- * @return the integer value that is used to code top level windows
- * "com.vaadin.ui.Window"
- */
- String getEncodedWindowTag() {
- return windowId;
- }
-
- String getUnknownServerClassNameByEncodedTagName(String tag) {
- if (unknownComponents != null) {
- return unknownComponents.get(tag);
- }
- return null;
- }
-
- /**
- *
- * @param c
- */
- static void runWhenWidgetsLoaded(Command c) {
- if (widgetsLoading == 0) {
- c.execute();
- } else {
- callbacks.add(c);
- }
- }
-
- static void startWidgetLoading() {
- widgetsLoading++;
- }
-
- static void endWidgetLoading() {
- widgetsLoading--;
- if (widgetsLoading == 0 && !callbacks.isEmpty()) {
- for (Command cmd : callbacks) {
- cmd.execute();
- }
- callbacks.clear();
- } else if (widgetsLoading == 0 && deferredWidgetLoader != null) {
- deferredWidgetLoader.trigger();
- }
-
- }
-
- /*
- * This loop loads widget implementation that should be loaded deferred.
- */
- static class DeferredWidgetLoader extends Timer {
- private static final int FREE_LIMIT = 4;
- private static final int FREE_CHECK_TIMEOUT = 100;
-
- int communicationFree = 0;
- int nextWidgetIndex = 0;
- private boolean pending;
-
- public DeferredWidgetLoader() {
- schedule(5000);
- }
-
- public void trigger() {
- if (!pending) {
- schedule(FREE_CHECK_TIMEOUT);
- }
- }
-
- @Override
- public void schedule(int delayMillis) {
- super.schedule(delayMillis);
- pending = true;
- }
-
- @Override
- public void run() {
- pending = false;
- if (!isBusy()) {
- Class<? extends VPaintableWidget> nextType = getNextType();
- if (nextType == null) {
- // ensured that all widgets are loaded
- deferredWidgetLoader = null;
- } else {
- communicationFree = 0;
- widgetSet.loadImplementation(nextType);
- }
- } else {
- schedule(FREE_CHECK_TIMEOUT);
- }
- }
-
- private Class<? extends VPaintableWidget> getNextType() {
- Class<? extends VPaintableWidget>[] deferredLoadedWidgets = widgetSet
- .getDeferredLoadedWidgets();
- if (deferredLoadedWidgets.length <= nextWidgetIndex) {
- return null;
- } else {
- return deferredLoadedWidgets[nextWidgetIndex++];
- }
- }
-
- private boolean isBusy() {
- if (widgetsLoading > 0) {
- communicationFree = 0;
- return true;
- }
- for (ApplicationConnection app : runningApplications) {
- if (app.hasActiveRequest()) {
- // if an UIDL request or widget loading is active, mark as
- // busy
- communicationFree = 0;
- return true;
- }
- }
- communicationFree++;
- return communicationFree < FREE_LIMIT;
- }
- }
-
- private static DeferredWidgetLoader deferredWidgetLoader;
-
- public void onModuleLoad() {
-
- // Prepare VConsole for debugging
- if (isDebugMode()) {
- Console console = GWT.create(Console.class);
- console.setQuietMode(isQuietDebugMode());
- console.init();
- VConsole.setImplementation(console);
- } else {
- VConsole.setImplementation((Console) GWT.create(NullConsole.class));
- }
- /*
- * Display some sort of error of exceptions in web mode to debug
- * console. After this, exceptions are reported to VConsole and possible
- * GWT hosted mode.
- */
- GWT.setUncaughtExceptionHandler(new UncaughtExceptionHandler() {
- public void onUncaughtException(Throwable e) {
- /*
- * Note in case of null console (without ?debug) we eat
- * exceptions. "a1 is not an object" style errors helps nobody,
- * especially end user. It does not work tells just as much.
- */
- VConsole.getImplementation().error(e);
- }
- });
-
- registerCallback(GWT.getModuleName());
- deferredWidgetLoader = new DeferredWidgetLoader();
- }
-
- /**
- * Registers that callback that the bootstrap javascript uses to start
- * applications once the widgetset is loaded and all required information is
- * available
- *
- * @param widgetsetName
- * the name of this widgetset
- */
- public native static void registerCallback(String widgetsetName)
- /*-{
- var callbackHandler = @com.vaadin.terminal.gwt.client.ApplicationConfiguration::startApplication(Ljava/lang/String;);
- $wnd.vaadin.registerWidgetset(widgetsetName, callbackHandler);
- }-*/;
-
- /**
- * Checks if client side is in debug mode. Practically this is invoked by
- * adding ?debug parameter to URI.
- *
- * @return true if client side is currently been debugged
- */
- public native static boolean isDebugMode()
- /*-{
- if($wnd.vaadin.debug) {
- var parameters = $wnd.location.search;
- var re = /debug[^\/]*$/;
- return re.test(parameters);
- } else {
- return false;
- }
- }-*/;
-
- /**
- * Checks whether debug logging should be quiet
- *
- * @return <code>true</code> if debug logging should be quiet
- */
- public native static boolean isQuietDebugMode()
- /*-{
- var uri = $wnd.location;
- var re = /debug=q[^\/]*$/;
- return re.test(uri);
- }-*/;
-
- /**
- * Checks whether information from the web browser (e.g. uri fragment and
- * screen size) has been sent to the server.
- *
- * @return <code>true</code> if browser information has already been sent
- *
- * @see ApplicationConnection#getNativeBrowserDetailsParameters(String)
- */
- public boolean isBrowserDetailsSent() {
- return browserDetailsSent;
- }
-
- /**
- * Registers that the browser details have been sent.
- * {@link #isBrowserDetailsSent()} will return
- * <code> after this method has been invoked.
- */
- public void setBrowserDetailsSent() {
- browserDetailsSent = true;
- }
-
- }
|