zervo/seb-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'master' of https://github.com/SafeExamBrowser/seb-server.git

Browse source
This commit is contained in:
anhefti 2020-03-03 15:47:22 +01:00
commit cccbc48805
61 changed files with 7744 additions and 7773 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
src/main/java/ch/ethz/seb/sebserver/gui/GuiInit.java
View file

@ -1,41 +1,41 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.SEBServerInit;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
@Component
@GuiProfile
public class GuiInit implements ApplicationListener<ApplicationReadyEvent> {
private final SEBServerInit sebServerInit;
protected GuiInit(final SEBServerInit sebServerInit) {
this.sebServerInit = sebServerInit;
}
@Override
public void onApplicationEvent(final ApplicationReadyEvent event) {
this.sebServerInit.init();
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> **** GUI Service starting up... ****");
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> GUI Service sucessfully successfully started up!");
SEBServerInit.INIT_LOGGER.info("---->");
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.SEBServerInit;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
@Component
@GuiProfile
public class GuiInit implements ApplicationListener<ApplicationReadyEvent> {
private final SEBServerInit sebServerInit;
protected GuiInit(final SEBServerInit sebServerInit) {
this.sebServerInit = sebServerInit;
}
@Override
public void onApplicationEvent(final ApplicationReadyEvent event) {
this.sebServerInit.init();
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> **** GUI Service starting up... ****");
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> GUI Service successfully successfully started up!");
SEBServerInit.INIT_LOGGER.info("---->");
}
}

16
src/main/java/ch/ethz/seb/sebserver/gui/InstitutionalAuthenticationEntryPoint.java
View file

@ -73,12 +73,12 @@ public final class InstitutionalAuthenticationEntryPoint implements Authenticati
this.webserviceURIService = webserviceURIService;
this.clientHttpRequestFactoryService = clientHttpRequestFactoryService;
String _defaultLogo = null;
String _defaultLogo;
if (!Constants.NO_NAME.equals(defaultLogoFileName)) {
try {
final String extension = ImageUploadSelection.SUPPORTED_IMAGE_FILES.stream()
.filter(ext -> defaultLogoFileName.endsWith(ext))
.filter(defaultLogoFileName::endsWith)
.findFirst()
.orElse(null);
@ -141,7 +141,7 @@ public final class InstitutionalAuthenticationEntryPoint implements Authenticati
: null);
if (log.isDebugEnabled()) {
log.debug("Known and active gui entrypoint requested:", institutions);
log.debug("Known and active gui entrypoint requested: {}", institutions);
}
final String logoImageBase64 = requestLogoImage(institutionalEndpoint);
@ -184,9 +184,7 @@ public final class InstitutionalAuthenticationEntryPoint implements Authenticati
}
try {
return requestURI.substring(
requestURI.lastIndexOf(Constants.SLASH) + 1,
requestURI.length());
return requestURI.substring(requestURI.lastIndexOf(Constants.SLASH) + 1);
} catch (final Exception e) {
log.error("Failed to extract institutional URL suffix: {}", e.getMessage());
return null;
@ -231,12 +229,12 @@ public final class InstitutionalAuthenticationEntryPoint implements Authenticati
if (exchange.getStatusCodeValue() == HttpStatus.OK.value()) {
return exchange.getBody();
} else {
log.warn("Failed to verify insitution from requested entrypoint url: {}, response: {}",
log.warn("Failed to verify institution from requested entrypoint url: {}, response: {}",
institutionalEndpoint,
exchange);
}
} catch (final Exception e) {
log.warn("Failed to verify insitution from requested entrypoint url: {}",
log.warn("Failed to verify institution from requested entrypoint url: {}",
institutionalEndpoint,
e);
}
@ -245,7 +243,7 @@ public final class InstitutionalAuthenticationEntryPoint implements Authenticati
}
/** TODO this seems not to work as expected. Different Theme is only possible in RAP on different
* entry-points and since entry-points are statically defined within the RAPConficuration
* entry-points and since entry-points are statically defined within the RAPConfiguration
* there is no possibility to apply them dynamically within an institution so far.
*
* @param institutionalEndpoint

328
src/main/java/ch/ethz/seb/sebserver/gui/RAPConfiguration.java
View file

@ -1,164 +1,164 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.application.AbstractEntryPoint;
import org.eclipse.rap.rwt.application.Application;
import org.eclipse.rap.rwt.application.ApplicationConfiguration;
import org.eclipse.rap.rwt.application.EntryPoint;
import org.eclipse.rap.rwt.application.EntryPointFactory;
import org.eclipse.rap.rwt.client.WebClient;
import org.eclipse.rap.rwt.internal.theme.ThemeUtil;
import org.eclipse.rap.rwt.service.ServiceManager;
import org.eclipse.swt.widgets.Composite;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;
import ch.ethz.seb.sebserver.gui.service.remote.download.DownloadService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.auth.AuthorizationContextHolder;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.auth.SEBServerAuthorizationContext;
public class RAPConfiguration implements ApplicationConfiguration {
private static final String DEFAULT_THEME_NAME = "sebserver";
private static final Logger log = LoggerFactory.getLogger(RAPConfiguration.class);
@Override
public void configure(final Application application) {
try {
// TODO get file path from properties
//application.addStyleSheet(RWT.DEFAULT_THEME_ID, "static/css/sebserver.css");
application.addStyleSheet(DEFAULT_THEME_NAME, "resource/theme/default.css");
application.addStyleSheet(DEFAULT_THEME_NAME, "static/css/sebserver.css");
application.addStyleSheet("sms", "resource/theme/default.css");
application.addStyleSheet("sms", "static/css/sms.css");
final Map<String, String> properties = new HashMap<>();
properties.put(WebClient.PAGE_TITLE, "SEB Server");
properties.put(WebClient.BODY_HTML, "<big>Loading Application<big>");
properties.put(WebClient.THEME_ID, DEFAULT_THEME_NAME);
// properties.put(WebClient.FAVICON, "icons/favicon.png");
application.addEntryPoint("/gui", new RAPSpringEntryPointFactory(), properties);
} catch (final RuntimeException re) {
throw re;
} catch (final Exception e) {
log.error("Error during CSS parsing. Please check the custom CSS files for errors.", e);
}
}
public static interface EntryPointService {
void loadLoginPage(final Composite parent);
void loadMainPage(final Composite parent);
}
public static final class RAPSpringEntryPointFactory implements EntryPointFactory {
private boolean initialized = false;
@Override
public EntryPoint create() {
return new AbstractEntryPoint() {
private static final long serialVersionUID = -1299125117752916270L;
@Override
protected void createContents(final Composite parent) {
final HttpSession httpSession = RWT
.getUISession(parent.getDisplay())
.getHttpSession();
log.debug("Create new GUI entrypoint. HttpSession: " + httpSession);
if (httpSession == null) {
log.error("HttpSession not available from RWT.getUISession().getHttpSession()");
throw new IllegalStateException(
"HttpSession not available from RWT.getUISession().getHttpSession()");
}
final Object themeId = httpSession.getAttribute("themeId");
if (themeId != null) {
ThemeUtil.setCurrentThemeId(RWT.getUISession(parent.getDisplay()), String.valueOf(themeId));
parent.redraw();
parent.layout(true);
parent.redraw();
}
final WebApplicationContext webApplicationContext = getWebApplicationContext(httpSession);
initSpringBasedRAPServices(webApplicationContext);
final EntryPointService entryPointService = webApplicationContext
.getBean(EntryPointService.class);
if (isAuthenticated(httpSession, webApplicationContext)) {
entryPointService.loadMainPage(parent);
} else {
entryPointService.loadLoginPage(parent);
}
}
};
}
private void initSpringBasedRAPServices(final WebApplicationContext webApplicationContext) {
if (!this.initialized) {
try {
final ServiceManager manager = RWT.getServiceManager();
final DownloadService downloadService = webApplicationContext.getBean(DownloadService.class);
manager.registerServiceHandler(DownloadService.DOWNLOAD_SERVICE_NAME, downloadService);
this.initialized = true;
} catch (final IllegalArgumentException iae) {
log.warn("Failed to register DownloadService on ServiceManager. Already registered: ", iae);
}
}
}
private boolean isAuthenticated(
final HttpSession httpSession,
final WebApplicationContext webApplicationContext) {
final AuthorizationContextHolder authorizationContextHolder = webApplicationContext
.getBean(AuthorizationContextHolder.class);
final SEBServerAuthorizationContext authorizationContext = authorizationContextHolder
.getAuthorizationContext(httpSession);
return authorizationContext.isValid() && authorizationContext.isLoggedIn();
}
private WebApplicationContext getWebApplicationContext(final HttpSession httpSession) {
try {
final ServletContext servletContext = httpSession.getServletContext();
log.debug("Initialize Spring-Context on Servlet-Context: " + servletContext);
return WebApplicationContextUtils
.getRequiredWebApplicationContext(servletContext);
} catch (final RuntimeException e) {
log.error("Failed to initialize Spring-Context on HttpSession: " + httpSession);
throw e;
} catch (final Exception e) {
log.error("Failed to initialize Spring-Context on HttpSession: " + httpSession);
throw new RuntimeException("Failed to initialize Spring-Context on HttpSession: " + httpSession);
}
}
};
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.application.AbstractEntryPoint;
import org.eclipse.rap.rwt.application.Application;
import org.eclipse.rap.rwt.application.ApplicationConfiguration;
import org.eclipse.rap.rwt.application.EntryPoint;
import org.eclipse.rap.rwt.application.EntryPointFactory;
import org.eclipse.rap.rwt.client.WebClient;
import org.eclipse.rap.rwt.internal.theme.ThemeUtil;
import org.eclipse.rap.rwt.service.ServiceManager;
import org.eclipse.swt.widgets.Composite;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;
import ch.ethz.seb.sebserver.gui.service.remote.download.DownloadService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.auth.AuthorizationContextHolder;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.auth.SEBServerAuthorizationContext;
public class RAPConfiguration implements ApplicationConfiguration {
private static final String DEFAULT_THEME_NAME = "sebserver";
private static final Logger log = LoggerFactory.getLogger(RAPConfiguration.class);
@Override
public void configure(final Application application) {
try {
// TODO get file path from properties
//application.addStyleSheet(RWT.DEFAULT_THEME_ID, "static/css/sebserver.css");
application.addStyleSheet(DEFAULT_THEME_NAME, "resource/theme/default.css");
application.addStyleSheet(DEFAULT_THEME_NAME, "static/css/sebserver.css");
application.addStyleSheet("sms", "resource/theme/default.css");
application.addStyleSheet("sms", "static/css/sms.css");
final Map<String, String> properties = new HashMap<>();
properties.put(WebClient.PAGE_TITLE, "SEB Server");
properties.put(WebClient.BODY_HTML, "<big>Loading Application<big>");
properties.put(WebClient.THEME_ID, DEFAULT_THEME_NAME);
// properties.put(WebClient.FAVICON, "icons/favicon.png");
application.addEntryPoint("/gui", new RAPSpringEntryPointFactory(), properties);
} catch (final RuntimeException re) {
throw re;
} catch (final Exception e) {
log.error("Error during CSS parsing. Please check the custom CSS files for errors.", e);
}
}
public interface EntryPointService {
void loadLoginPage(final Composite parent);
void loadMainPage(final Composite parent);
}
public static final class RAPSpringEntryPointFactory implements EntryPointFactory {
private boolean initialized = false;
@Override
public EntryPoint create() {
return new AbstractEntryPoint() {
private static final long serialVersionUID = -1299125117752916270L;
@Override
protected void createContents(final Composite parent) {
final HttpSession httpSession = RWT
.getUISession(parent.getDisplay())
.getHttpSession();
log.debug("Create new GUI entrypoint. HttpSession: " + httpSession);
if (httpSession == null) {
log.error("HttpSession not available from RWT.getUISession().getHttpSession()");
throw new IllegalStateException(
"HttpSession not available from RWT.getUISession().getHttpSession()");
}
final Object themeId = httpSession.getAttribute("themeId");
if (themeId != null) {
ThemeUtil.setCurrentThemeId(RWT.getUISession(parent.getDisplay()), String.valueOf(themeId));
parent.redraw();
parent.layout(true);
parent.redraw();
}
final WebApplicationContext webApplicationContext = getWebApplicationContext(httpSession);
initSpringBasedRAPServices(webApplicationContext);
final EntryPointService entryPointService = webApplicationContext
.getBean(EntryPointService.class);
if (isAuthenticated(httpSession, webApplicationContext)) {
entryPointService.loadMainPage(parent);
} else {
entryPointService.loadLoginPage(parent);
}
}
};
}
private void initSpringBasedRAPServices(final WebApplicationContext webApplicationContext) {
if (!this.initialized) {
try {
final ServiceManager manager = RWT.getServiceManager();
final DownloadService downloadService = webApplicationContext.getBean(DownloadService.class);
manager.registerServiceHandler(DownloadService.DOWNLOAD_SERVICE_NAME, downloadService);
this.initialized = true;
} catch (final IllegalArgumentException iae) {
log.warn("Failed to register DownloadService on ServiceManager. Already registered: ", iae);
}
}
}
private boolean isAuthenticated(
final HttpSession httpSession,
final WebApplicationContext webApplicationContext) {
final AuthorizationContextHolder authorizationContextHolder = webApplicationContext
.getBean(AuthorizationContextHolder.class);
final SEBServerAuthorizationContext authorizationContext = authorizationContextHolder
.getAuthorizationContext(httpSession);
return authorizationContext.isValid() && authorizationContext.isLoggedIn();
}
private WebApplicationContext getWebApplicationContext(final HttpSession httpSession) {
try {
final ServletContext servletContext = httpSession.getServletContext();
log.debug("Initialize Spring-Context on Servlet-Context: " + servletContext);
return WebApplicationContextUtils
.getRequiredWebApplicationContext(servletContext);
} catch (final RuntimeException e) {
log.error("Failed to initialize Spring-Context on HttpSession: " + httpSession);
throw e;
} catch (final Exception e) {
log.error("Failed to initialize Spring-Context on HttpSession: " + httpSession);
throw new RuntimeException("Failed to initialize Spring-Context on HttpSession: " + httpSession);
}
}
}
}

164
src/main/java/ch/ethz/seb/sebserver/gui/RAPSpringConfig.java
View file

@ -1,83 +1,81 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextListener;
import javax.servlet.ServletException;
import org.eclipse.rap.rwt.engine.RWTServlet;
import org.eclipse.rap.rwt.engine.RWTServletContextListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.servlet.ServletContextInitializer;
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
@Configuration
@GuiProfile
public class RAPSpringConfig {
private static final Logger log = LoggerFactory.getLogger(RAPSpringConfig.class);
@Value("${sebserver.gui.entrypoint}")
private String entrypoint;
@Value("${sebserver.gui.external.messages:messages}")
private String externalMessagesPath;
@Bean
public ServletContextInitializer initializer() {
return new RAPServletContextInitializer();
}
@Bean
public ServletListenerRegistrationBean<ServletContextListener> listenerRegistrationBean() {
final ServletListenerRegistrationBean<ServletContextListener> bean =
new ServletListenerRegistrationBean<>();
bean.setListener(new RWTServletContextListener());
return bean;
}
@Bean
public ServletRegistrationBean<RWTServlet> servletRegistrationBean() {
return new ServletRegistrationBean<>(new RWTServlet(), this.entrypoint + "/*");
}
@Bean
public MessageSource messageSource() {
final ReloadableResourceBundleMessageSource reloadableResourceBundleMessageSource =
new ReloadableResourceBundleMessageSource();
log.info(" +++ Register external messages resources from: {}", this.externalMessagesPath);
reloadableResourceBundleMessageSource.setBasenames(
this.externalMessagesPath,
"classpath:messages");
return reloadableResourceBundleMessageSource;
}
private static class RAPServletContextInitializer implements ServletContextInitializer {
@Override
public void onStartup(final ServletContext servletContext) throws ServletException {
servletContext.setInitParameter(
"org.eclipse.rap.applicationConfiguration",
RAPConfiguration.class.getName());
}
}
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import org.eclipse.rap.rwt.engine.RWTServlet;
import org.eclipse.rap.rwt.engine.RWTServletContextListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.servlet.ServletContextInitializer;
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextListener;
@Configuration
@GuiProfile
public class RAPSpringConfig {
private static final Logger log = LoggerFactory.getLogger(RAPSpringConfig.class);
@Value("${sebserver.gui.entrypoint}")
private String entrypoint;
@Value("${sebserver.gui.external.messages:messages}")
private String externalMessagesPath;
@Bean
public ServletContextInitializer initializer() {
return new RAPServletContextInitializer();
}
@Bean
public ServletListenerRegistrationBean<ServletContextListener> listenerRegistrationBean() {
final ServletListenerRegistrationBean<ServletContextListener> bean =
new ServletListenerRegistrationBean<>();
bean.setListener(new RWTServletContextListener());
return bean;
}
@Bean
public ServletRegistrationBean<RWTServlet> servletRegistrationBean() {
return new ServletRegistrationBean<>(new RWTServlet(), this.entrypoint + "/*");
}
@Bean
public MessageSource messageSource() {
final ReloadableResourceBundleMessageSource reloadableResourceBundleMessageSource =
new ReloadableResourceBundleMessageSource();
log.info(" +++ Register external messages resources from: {}", this.externalMessagesPath);
reloadableResourceBundleMessageSource.setBasenames(
this.externalMessagesPath,
"classpath:messages");
return reloadableResourceBundleMessageSource;
}
private static class RAPServletContextInitializer implements ServletContextInitializer {
@Override
public void onStartup(final ServletContext servletContext) {
servletContext.setInitParameter(
"org.eclipse.rap.applicationConfiguration",
RAPConfiguration.class.getName());
}
}
}

4
src/main/java/ch/ethz/seb/sebserver/gui/service/ResourceService.java
View file

@ -82,8 +82,8 @@ public class ResourceService {
private static final String MISSING_CLIENT_PING_NAME_KEY = "MISSING";
public static final Comparator<Tuple<String>> RESOURCE_COMPARATOR = (t1, t2) -> t1._2.compareTo(t2._2);
public static final Comparator<Tuple3<String>> RESOURCE_COMPARATOR_TUPLE_3 = (t1, t2) -> t1._2.compareTo(t2._2);
public static final Comparator<Tuple<String>> RESOURCE_COMPARATOR = Comparator.comparing(t -> t._2);
public static final Comparator<Tuple3<String>> RESOURCE_COMPARATOR_TUPLE_3 = Comparator.comparing(t -> t._2);
public static final EnumSet<EntityType> ENTITY_TYPE_EXCLUDE_MAP = EnumSet.of(
EntityType.ADDITIONAL_ATTRIBUTES,

100
src/main/java/ch/ethz/seb/sebserver/gui/service/page/FieldValidationError.java
View file

@ -1,50 +1,50 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
import java.util.Collection;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.util.Utils;
public class FieldValidationError {
public final String messageCode;
public final String domainName;
public final String fieldName;
public final String errorType;
public final Collection<String> attributes;
public FieldValidationError(final APIMessage apiMessage) {
this(
apiMessage.messageCode,
apiMessage.attributes.toArray(new String[apiMessage.attributes.size()]));
}
public FieldValidationError(
final String messageCode,
final String[] attributes) {
this.messageCode = messageCode;
this.attributes = Utils.immutableCollectionOf(attributes);
this.domainName = (attributes != null && attributes.length > 0) ? attributes[0] : null;
this.fieldName = (attributes != null && attributes.length > 1) ? attributes[1] : null;
this.errorType = (attributes != null && attributes.length > 2) ? attributes[2] : null;
}
public String[] getAttributes() {
if (this.attributes == null) {
return new String[0];
}
return this.attributes.toArray(new String[this.attributes.size()]);
}
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
import java.util.Collection;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.util.Utils;
public class FieldValidationError {
public final String messageCode;
public final String domainName;
public final String fieldName;
public final String errorType;
public final Collection<String> attributes;
public FieldValidationError(final APIMessage apiMessage) {
this(
apiMessage.messageCode,
apiMessage.attributes.toArray(new String[0]));
}
public FieldValidationError(
final String messageCode,
final String[] attributes) {
this.messageCode = messageCode;
this.attributes = Utils.immutableCollectionOf(attributes);
this.domainName = (attributes != null && attributes.length > 0) ? attributes[0] : null;
this.fieldName = (attributes != null && attributes.length > 1) ? attributes[1] : null;
this.errorType = (attributes != null && attributes.length > 2) ? attributes[2] : null;
}
public String[] getAttributes() {
if (this.attributes == null) {
return new String[0];
}
return this.attributes.toArray(new String[0]);
}
}

584
src/main/java/ch/ethz/seb/sebserver/gui/service/page/PageContext.java
View file

@ -1,292 +1,292 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
import java.util.function.Consumer;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Shell;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.model.EntityKey;
import ch.ethz.seb.sebserver.gui.service.ResourceService;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
/** Holds a page-context and defines some convenient functionality for page handling */
public interface PageContext {
Logger log = LoggerFactory.getLogger(PageContext.class);
/** Defines attribute keys that can be used to store attribute values within the page context state */
public interface AttributeKeys {
public static final String PAGE_TEMPLATE_COMPOSER_NAME = "ATTR_PAGE_TEMPLATE_COMPOSER_NAME";
public static final String READ_ONLY = "READ_ONLY";
public static final String READ_ONLY_FROM = "READ_ONLY_FROM";
public static final String ENTITY_ID = "ENTITY_ID";
public static final String PARENT_ENTITY_ID = "PARENT_ENTITY_ID";
public static final String ENTITY_TYPE = "ENTITY_TYPE";
public static final String PARENT_ENTITY_TYPE = "PARENT_ENTITY_TYPE";
public static final String IMPORT_FROM_QUIZ_DATA = "IMPORT_FROM_QUIZ_DATA";
public static final String COPY_AS_TEMPLATE = "COPY_AS_TEMPLATE";
public static final String CREATE_FROM_TEMPLATE = "CREATE_FROM_TEMPLATE";
}
/** The resource-bundle key of the generic load entity error message. */
public static final String GENERIC_LOAD_ERROR_TEXT_KEY = "sebserver.error.get.entity";
public static final String GENERIC_REMOVE_ERROR_TEXT_KEY = "sebserver.error.remove.entity";
public static final String GENERIC_SAVE_ERROR_TEXT_KEY = "sebserver.error.save.entity";
public static final String GENERIC_ACTIVATE_ERROR_TEXT_KEY = "sebserver.error.activate.entity";
public static final String GENERIC_IMPORT_ERROR_TEXT_KEY = "sebserver.error.import";
public static final LocTextKey SUCCESS_MSG_TITLE =
new LocTextKey("sebserver.page.message");
public static final LocTextKey UNEXPECTED_ERROR_KEY =
new LocTextKey("sebserver.error.action.unexpected.message");
/** Get the I18nSupport service
*
* @return the I18nSupport service */
I18nSupport getI18nSupport();
/** Use this to get the ComposerService used by this PageContext
*
* @return the ComposerService used by this PageContext */
ComposerService composerService();
/** Get the RWT Shell that is bound within this PageContext
*
* @return the RWT Shell that is bound within this PageContext */
Shell getShell();
/** Get the page root Component.
*
* @return the page root Component. */
Composite getRoot();
/** Get the Component that is currently set as parent during page tree compose
*
* @return the parent Component */
Composite getParent();
/** Get a copy of this PageContext.
*
* @return */
PageContext copy();
/** Create a copy of this PageContext with a new parent Composite.
* The implementation should take care of the imutability of PageContext and return a copy with the new parent
* by leave this PageContext as is.
*
* @param parent the new parent Composite
* @return a copy of this PageContext with a new parent Composite. */
PageContext copyOf(Composite parent);
/** Create a copy of this PageContext with and additionally page context attributes.
* The additionally page context attributes will get merged with them already defined
* The implementation should take care of the imutability of PageContext and return a copy with the merge
* by leave this and the given PageContext as is.
*
* @param attributes additionally page context attributes.
* @return a copy of this PageContext with with and additionally page context attributes. */
PageContext copyOfAttributes(PageContext otherContext);
/** Adds the specified attribute to the existing page context attributes.
* The implementation should take care of the imutability of PageContext and return a copy
* by leave this PageContext as is.
*
* @param key the key of the attribute
* @param value the value of the attribute
* @return this PageContext instance (builder pattern) */
PageContext withAttribute(String key, String value);
/** Gets a copy of this PageContext with cleared attribute map.
*
* @return a copy of this PageContext with cleared attribute map. */
PageContext clearAttributes();
/** Get the attribute value that is mapped to the given name or null of no mapping exists
*
* @param name the attribute name
* @return the attribute value that is mapped to the given name or null if no mapping exists */
String getAttribute(String name);
/** Get the attribute value that is mapped to the given name or a default value if no mapping exists
*
* @param name the attribute name
* @param def the default value
* @return the attribute value that is mapped to the given name or null of no mapping exists */
String getAttribute(String name, String def);
/** Indicates if the attribute with the key READ_ONLY is set to true within this PageContext
*
* @return true if the attribute with the key READ_ONLY is set to true */
boolean isReadonly();
/** Gets an EntityKey for the base Entity that is associated within this PageContext by using
* the attribute keys ENTITY_ID and ENTITY_TYPE to fetch the attribute values for an EntityKey
*
* @return the EntityKey of the base Entity that is associated within this PageContext */
EntityKey getEntityKey();
/** Gets an EntityKey for the parent Entity that is associated within this PageContext by using
* the attribute keys PARENT_ENTITY_ID and PARENT_ENTITY_TYPE to fetch the attribute values for an EntityKey
*
* @return the EntityKey of the parent Entity that is associated within this PageContext */
EntityKey getParentEntityKey();
/** Adds a given EntityKey as base Entity key to a new PageContext that is returned as a copy of this PageContext.
*
* @param entityKey the EntityKey to add as base Entity key
* @return the new PageContext with the EntityKey added */
PageContext withEntityKey(EntityKey entityKey);
/** Adds a given EntityKey as parent Entity key to a new PageContext that is returned as a copy of this PageContext.
*
* @param entityKey the EntityKey to add as parent Entity key
* @return the new PageContext with the EntityKey added */
PageContext withParentEntityKey(EntityKey entityKey);
/** Create a copy of this PageContext and resets both entity keys attributes, the base and the parent EntityKey
*
* @return copy of this PageContext with reseted EntityKey attributes (base and parent) */
PageContext clearEntityKeys();
/** Indicates if an attribute with the specified name exists within this PageContext
*
* @param name the name of the attribute
* @return true if the attribute with the specified name exists within this PageContext */
boolean hasAttribute(String name);
/** Returns a new PageContext with the removed attribute by name
*
* @param name the name of the attribute to remove
* @return a copy of this PageContext with the removed attribute */
PageContext removeAttribute(String name);
/** Apply a confirm dialog with a specified confirm message and a callback code
* block that will be executed on users OK selection.
*
* @param confirmMessage the localized confirm message key
* @param onOK callback code block that will be called on users selection */
void applyConfirmDialog(LocTextKey confirmMessage, final Consumer<Boolean> callback);
/** This can be used to forward to a defined page.
*
* @param pageDefinition the defined page */
void forwardToPage(PageDefinition pageDefinition);
/** Forward to main page */
void forwardToMainPage();
/** Forward to login page */
void forwardToLoginPage();
/** Notify an error dialog to the user with specified error message and
* optional exception instance
*
* @param errorMessage the error message to display
* @param error the error as Exception */
void notifyError(LocTextKey errorMessage, Exception error);
/** Notify a generic load error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifyLoadError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_LOAD_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic remove error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifyRemoveError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_REMOVE_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic save error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifySaveError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_SAVE_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic activation error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifyActivationError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_ACTIVATE_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic import error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifyImportError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_IMPORT_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic unexpected error to the user by pop-up
*
* @param error the original error */
default void notifyUnexpectedError(final Exception error) {
notifyError(UNEXPECTED_ERROR_KEY, error);
}
/** Publish and shows a message to the user with the given localized title and
* localized message. The message text can also be HTML text as far as RWT supports it.
*
* @param title the localized text key of the title message
* @param message the localized text key of the message */
void publishPageMessage(LocTextKey title, LocTextKey message);
/** Publish an information message to the user with the given localized message.
* The message text can also be HTML text as far as RWT supports it
*
* @param message the localized text key of the message */
default void publishInfo(final LocTextKey message) {
publishPageMessage(new LocTextKey("sebserver.page.message"), message);
}
/** Publish and shows a formatted PageMessageException to the user.
*
* @param pme the PageMessageException */
void publishPageMessage(PageMessageException pme);
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
import java.util.function.Consumer;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Shell;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.model.EntityKey;
import ch.ethz.seb.sebserver.gui.service.ResourceService;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
/** Holds a page-context and defines some convenient functionality for page handling */
public interface PageContext {
Logger log = LoggerFactory.getLogger(PageContext.class);
/** Defines attribute keys that can be used to store attribute values within the page context state */
interface AttributeKeys {
String PAGE_TEMPLATE_COMPOSER_NAME = "ATTR_PAGE_TEMPLATE_COMPOSER_NAME";
String READ_ONLY = "READ_ONLY";
String READ_ONLY_FROM = "READ_ONLY_FROM";
String ENTITY_ID = "ENTITY_ID";
String PARENT_ENTITY_ID = "PARENT_ENTITY_ID";
String ENTITY_TYPE = "ENTITY_TYPE";
String PARENT_ENTITY_TYPE = "PARENT_ENTITY_TYPE";
String IMPORT_FROM_QUIZ_DATA = "IMPORT_FROM_QUIZ_DATA";
String COPY_AS_TEMPLATE = "COPY_AS_TEMPLATE";
String CREATE_FROM_TEMPLATE = "CREATE_FROM_TEMPLATE";
}
/** The resource-bundle key of the generic load entity error message. */
String GENERIC_LOAD_ERROR_TEXT_KEY = "sebserver.error.get.entity";
String GENERIC_REMOVE_ERROR_TEXT_KEY = "sebserver.error.remove.entity";
String GENERIC_SAVE_ERROR_TEXT_KEY = "sebserver.error.save.entity";
String GENERIC_ACTIVATE_ERROR_TEXT_KEY = "sebserver.error.activate.entity";
String GENERIC_IMPORT_ERROR_TEXT_KEY = "sebserver.error.import";
LocTextKey SUCCESS_MSG_TITLE =
new LocTextKey("sebserver.page.message");
LocTextKey UNEXPECTED_ERROR_KEY =
new LocTextKey("sebserver.error.action.unexpected.message");
/** Get the I18nSupport service
*
* @return the I18nSupport service */
I18nSupport getI18nSupport();
/** Use this to get the ComposerService used by this PageContext
*
* @return the ComposerService used by this PageContext */
ComposerService composerService();
/** Get the RWT Shell that is bound within this PageContext
*
* @return the RWT Shell that is bound within this PageContext */
Shell getShell();
/** Get the page root Component.
*
* @return the page root Component. */
Composite getRoot();
/** Get the Component that is currently set as parent during page tree compose
*
* @return the parent Component */
Composite getParent();
/** Get a copy of this PageContext.
*
* @return a deep copy of this PageContext */
PageContext copy();
/** Create a copy of this PageContext with a new parent Composite.
* The implementation should take care of the immutability of PageContext and return a copy with the new parent
* by leave this PageContext as is.
*
* @param parent the new parent Composite
* @return a copy of this PageContext with a new parent Composite. */
PageContext copyOf(Composite parent);
/** Create a copy of this PageContext with and additionally page context attributes.
* The additionally page context attributes will get merged with them already defined
* The implementation should take care of the immutability of PageContext and return a copy with the merge
* by leave this and the given PageContext as is.
*
* @param otherContext the other PageContext to copy the attributes from
* @return a copy of this PageContext with with and additionally page context attributes. */
PageContext copyOfAttributes(PageContext otherContext);
/** Adds the specified attribute to the existing page context attributes.
* The implementation should take care of the immutability of PageContext and return a copy
* by leave this PageContext as is.
*
* @param key the key of the attribute
* @param value the value of the attribute
* @return this PageContext instance (builder pattern) */
PageContext withAttribute(String key, String value);
/** Gets a copy of this PageContext with cleared attribute map.
*
* @return a copy of this PageContext with cleared attribute map. */
PageContext clearAttributes();
/** Get the attribute value that is mapped to the given name or null of no mapping exists
*
* @param name the attribute name
* @return the attribute value that is mapped to the given name or null if no mapping exists */
String getAttribute(String name);
/** Get the attribute value that is mapped to the given name or a default value if no mapping exists
*
* @param name the attribute name
* @param def the default value
* @return the attribute value that is mapped to the given name or null of no mapping exists */
String getAttribute(String name, String def);
/** Indicates if the attribute with the key READ_ONLY is set to true within this PageContext
*
* @return true if the attribute with the key READ_ONLY is set to true */
boolean isReadonly();
/** Gets an EntityKey for the base Entity that is associated within this PageContext by using
* the attribute keys ENTITY_ID and ENTITY_TYPE to fetch the attribute values for an EntityKey
*
* @return the EntityKey of the base Entity that is associated within this PageContext */
EntityKey getEntityKey();
/** Gets an EntityKey for the parent Entity that is associated within this PageContext by using
* the attribute keys PARENT_ENTITY_ID and PARENT_ENTITY_TYPE to fetch the attribute values for an EntityKey
*
* @return the EntityKey of the parent Entity that is associated within this PageContext */
EntityKey getParentEntityKey();
/** Adds a given EntityKey as base Entity key to a new PageContext that is returned as a copy of this PageContext.
*
* @param entityKey the EntityKey to add as base Entity key
* @return the new PageContext with the EntityKey added */
PageContext withEntityKey(EntityKey entityKey);
/** Adds a given EntityKey as parent Entity key to a new PageContext that is returned as a copy of this PageContext.
*
* @param entityKey the EntityKey to add as parent Entity key
* @return the new PageContext with the EntityKey added */
PageContext withParentEntityKey(EntityKey entityKey);
/** Create a copy of this PageContext and resets both entity keys attributes, the base and the parent EntityKey
*
* @return copy of this PageContext with reset EntityKey attributes (base and parent) */
PageContext clearEntityKeys();
/** Indicates if an attribute with the specified name exists within this PageContext
*
* @param name the name of the attribute
* @return true if the attribute with the specified name exists within this PageContext */
boolean hasAttribute(String name);
/** Returns a new PageContext with the removed attribute by name
*
* @param name the name of the attribute to remove
* @return a copy of this PageContext with the removed attribute */
PageContext removeAttribute(String name);
/** Apply a confirm dialog with a specified confirm message and a callback code
* block that will be executed on users OK selection.
*
* @param confirmMessage the localized confirm message key
* @param callback callback code block that will be called on users selection */
void applyConfirmDialog(LocTextKey confirmMessage, final Consumer<Boolean> callback);
/** This can be used to forward to a defined page.
*
* @param pageDefinition the defined page */
void forwardToPage(PageDefinition pageDefinition);
/** Forward to main page */
void forwardToMainPage();
/** Forward to login page */
void forwardToLoginPage();
/** Notify an error dialog to the user with specified error message and
* optional exception instance
*
* @param errorMessage the error message to display
* @param error the error as Exception */
void notifyError(LocTextKey errorMessage, Exception error);
/** Notify a generic load error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifyLoadError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_LOAD_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic remove error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifyRemoveError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_REMOVE_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic save error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifySaveError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_SAVE_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic activation error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifyActivationError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_ACTIVATE_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic import error to the user by pop-up
*
* @param entityType the type of the entity
* @param error the original error */
default void notifyImportError(final EntityType entityType, final Exception error) {
notifyError(
new LocTextKey(
GENERIC_IMPORT_ERROR_TEXT_KEY,
getI18nSupport().getText(ResourceService.getEntityTypeNameKey(entityType))),
error);
}
/** Notify a generic unexpected error to the user by pop-up
*
* @param error the original error */
default void notifyUnexpectedError(final Exception error) {
notifyError(UNEXPECTED_ERROR_KEY, error);
}
/** Publish and shows a message to the user with the given localized title and
* localized message. The message text can also be HTML text as far as RWT supports it.
*
* @param title the localized text key of the title message
* @param message the localized text key of the message */
void publishPageMessage(LocTextKey title, LocTextKey message);
/** Publish an information message to the user with the given localized message.
* The message text can also be HTML text as far as RWT supports it
*
* @param message the localized text key of the message */
default void publishInfo(final LocTextKey message) {
publishPageMessage(new LocTextKey("sebserver.page.message"), message);
}
/** Publish and shows a formatted PageMessageException to the user.
*
* @param pme the PageMessageException */
void publishPageMessage(PageMessageException pme);
}

36
src/main/java/ch/ethz/seb/sebserver/gui/service/page/PageDefinition.java
View file

@ -1,16 +1,20 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
public interface PageDefinition {
Class<? extends TemplateComposer> composer();
PageContext applyPageContext(PageContext pageContext);
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
/** Defines a global SEB Server page */
public interface PageDefinition {
/** Get the type class of the TemplateComposer that composes the page.
*
* @return the type class of the TemplateComposer that composes the page. */
Class<? extends TemplateComposer> composer();
PageContext applyPageContext(PageContext pageContext);
}

2
src/main/java/ch/ethz/seb/sebserver/gui/service/page/PageService.java
View file

@ -363,7 +363,7 @@ public interface PageService {
return content;
}
/** Used to update the crolledComposite when some if its content has dynamically changed
/** Used to update the scrolledComposite when some if its content has dynamically changed
* its dimensions.
*
* @param composite The Component that changed its dimensions */

60
src/main/java/ch/ethz/seb/sebserver/gui/service/page/PageStateDefinition.java
View file

@ -1,30 +1,30 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
public interface PageStateDefinition {
enum Type {
UNDEFINED,
LIST_VIEW,
FORM_VIEW,
FORM_EDIT,
FORM_IN_TIME_EDIT
}
String name();
Type type();
public Class<? extends TemplateComposer> contentPaneComposer();
public Class<? extends TemplateComposer> actionPaneComposer();
Activity activityAnchor();
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
public interface PageStateDefinition {
enum Type {
UNDEFINED,
LIST_VIEW,
FORM_VIEW,
FORM_EDIT,
FORM_IN_TIME_EDIT
}
String name();
Type type();
Class<? extends TemplateComposer> contentPaneComposer();
Class<? extends TemplateComposer> actionPaneComposer();
Activity activityAnchor();
}

46
src/main/java/ch/ethz/seb/sebserver/gui/service/page/TemplateComposer.java
View file

@ -1,19 +1,27 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
public interface TemplateComposer {
default boolean validate(final PageContext pageContext) {
return true;
}
void compose(PageContext pageContext);
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page;
/** interface defining a RAP page template composer */
public interface TemplateComposer {
/** Validate given PageContext for completeness to compose a specific TemplateComposer implementation
* Default returns always true.
* @param pageContext The PageContext instance to check
* @return true if the PageContext contains all mandatory data to compose this page template */
default boolean validate(final PageContext pageContext) {
return true;
}
/** Compose a specific page template for the given PageContext
*
* @param pageContext The PageContext instance */
void compose(PageContext pageContext);
}

728
src/main/java/ch/ethz/seb/sebserver/gui/service/page/impl/DefaultPageLayout.java
View file

@ -1,366 +1,362 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page.impl;
import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import org.apache.commons.codec.binary.Base64InputStream;
import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.client.service.UrlLauncher;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.ImageData;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.MessageBox;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.i18n.PolyglotPageService;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.service.page.PageContext.AttributeKeys;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.service.page.TemplateComposer;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.auth.AuthorizationContextHolder;
import ch.ethz.seb.sebserver.gui.widget.Message;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.CustomVariant;
@Lazy
@Component
public class DefaultPageLayout implements TemplateComposer {
private static final Logger log = LoggerFactory.getLogger(DefaultPageLayout.class);
private static final LocTextKey ABOUT_TEXT_KEY = new LocTextKey("sebserver.overall.about");
private static final LocTextKey IMPRINT_TEXT_KEY = new LocTextKey("sebserver.overall.imprint");
private static final LocTextKey HELP_TEXT_KEY = new LocTextKey("sebserver.overall.help");
private static final LocTextKey ABOUT_MARKUP_TEXT_KEY = new LocTextKey("sebserver.overall.about.markup");
private static final LocTextKey IMPRINT_MARKUP_TEXT_KEY = new LocTextKey("sebserver.overall.imprint.markup");
private static final LocTextKey HELP_LINK_TEXT_KEY = new LocTextKey("sebserver.overall.help.link");
public static final int LOGO_IMAGE_MAX_WIDTH = 400;
public static final int LOGO_IMAGE_MAX_HEIGHT = 80;
private final WidgetFactory widgetFactory;
private final PolyglotPageService polyglotPageService;
private final AuthorizationContextHolder authorizationContextHolder;
private final PageService pageService;
private final String sebServerVersion;
private final boolean multilingual;
public DefaultPageLayout(
final PageService pageService,
final Environment environment) {
this.widgetFactory = pageService.getWidgetFactory();
this.polyglotPageService = pageService.getPolyglotPageService();
this.authorizationContextHolder = pageService.getAuthorizationContextHolder();
this.pageService = pageService;
this.sebServerVersion = environment.getProperty("sebserver.version", Constants.EMPTY_NOTE);
this.multilingual = BooleanUtils.toBoolean(environment.getProperty("sebserver.gui.multilingual", "false"));
}
@Override
public boolean validate(final PageContext pageContext) {
return pageContext.hasAttribute(AttributeKeys.PAGE_TEMPLATE_COMPOSER_NAME);
}
@Override
public void compose(final PageContext pageContext) {
final GridLayout skeletonLayout = new GridLayout();
skeletonLayout.marginBottom = 0;
skeletonLayout.marginLeft = 0;
skeletonLayout.marginRight = 0;
skeletonLayout.marginTop = 0;
skeletonLayout.marginHeight = 0;
skeletonLayout.marginWidth = 0;
skeletonLayout.verticalSpacing = 0;
skeletonLayout.horizontalSpacing = 0;
pageContext.getParent().setLayout(skeletonLayout);
composeHeader(pageContext);
composeLogoBar(pageContext);
composeContent(pageContext);
composeFooter(pageContext);
this.polyglotPageService.setDefaultPageLocale(pageContext.getRoot());
}
private void composeHeader(final PageContext pageContext) {
final Composite header = new Composite(pageContext.getParent(), SWT.NONE);
final GridLayout gridLayout = new GridLayout();
gridLayout.marginRight = 50;
gridLayout.marginLeft = 50;
header.setLayout(gridLayout);
final GridData headerCell = new GridData(SWT.FILL, SWT.TOP, true, false);
headerCell.minimumHeight = 40;
headerCell.heightHint = 40;
header.setLayoutData(headerCell);
header.setData(RWT.CUSTOM_VARIANT, "header");
final Composite headerRight = new Composite(header, SWT.NONE);
headerRight.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, true, true));
final GridLayout headerRightGrid = new GridLayout(2, false);
headerRightGrid.marginHeight = 0;
headerRightGrid.marginWidth = 0;
headerRightGrid.horizontalSpacing = 20;
headerRight.setLayout(headerRightGrid);
headerRight.setData(RWT.CUSTOM_VARIANT, "header");
if (this.authorizationContextHolder.getAuthorizationContext().isLoggedIn()) {
final Label username = new Label(headerRight, SWT.NONE);
username.setData(RWT.CUSTOM_VARIANT, "header");
username.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, true, true));
username.setText(this.authorizationContextHolder
.getAuthorizationContext()
.getLoggedInUser()
.get(t -> this.pageService.logoutOnError(t, pageContext)).username);
final Button logout = this.widgetFactory.buttonLocalized(headerRight, "sebserver.logout");
logout.setLayoutData(new GridData(SWT.RIGHT, SWT.FILL, true, true));
logout.setData(RWT.CUSTOM_VARIANT, "header");
logout.addListener(SWT.Selection, event -> {
this.pageService.logout(pageContext);
// show successful logout message
final MessageBox logoutSuccess = new Message(
pageContext.getShell(),
this.polyglotPageService.getI18nSupport().getText("sebserver.logout"),
this.polyglotPageService.getI18nSupport().getText("sebserver.logout.success.message"),
SWT.ICON_INFORMATION,
pageContext.getI18nSupport());
logoutSuccess.open(null);
// TODO Try to invalidate RWT's user session.
// This seems to be more difficult then expected and just invalidate the HttpSession dosn't work
// Try to send a redirect JSON to the client: https://bugs.eclipse.org/bugs/show_bug.cgi?id=388249
});
}
}
private void composeLogoBar(final PageContext pageContext) {
final Composite logoBar = new Composite(pageContext.getParent(), SWT.NONE);
final GridData logoBarCell = new GridData(SWT.FILL, SWT.TOP, false, false);
logoBarCell.minimumHeight = 80;
logoBarCell.heightHint = 80;
logoBar.setLayoutData(logoBarCell);
logoBar.setData(RWT.CUSTOM_VARIANT, "logo");
final GridLayout logoBarLayout = new GridLayout(2, false);
logoBarLayout.horizontalSpacing = 0;
logoBarLayout.marginHeight = 0;
logoBar.setLayout(logoBarLayout);
final Composite logo = new Composite(logoBar, SWT.NONE);
final GridData logoCell = new GridData(SWT.LEFT, SWT.CENTER, true, true);
logoCell.minimumHeight = LOGO_IMAGE_MAX_HEIGHT;
logoCell.heightHint = LOGO_IMAGE_MAX_HEIGHT;
logoCell.minimumWidth = LOGO_IMAGE_MAX_WIDTH;
logoCell.horizontalIndent = 50;
logo.setLayoutData(logoCell);
// try to get institutional logo first. If no success, use default logo
loadInstitutionalLogo(pageContext, logo);
final Composite langSupport = new Composite(logoBar, SWT.NONE);
final GridData langSupportCell = new GridData(SWT.RIGHT, SWT.CENTER, false, false);
langSupportCell.heightHint = 20;
logoCell.horizontalIndent = 50;
langSupport.setLayoutData(langSupportCell);
langSupport.setData(RWT.CUSTOM_VARIANT, "logo");
final RowLayout rowLayout = new RowLayout(SWT.HORIZONTAL);
rowLayout.spacing = 7;
rowLayout.marginRight = 70;
langSupport.setLayout(rowLayout);
if (this.multilingual) {
this.polyglotPageService.createLanguageSelector(pageContext.copyOf(langSupport));
}
}
private void composeContent(final PageContext pageContext) {
final Composite contentBackground = new Composite(pageContext.getParent(), SWT.NONE);
contentBackground.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
contentBackground.setData(RWT.CUSTOM_VARIANT, "bgContent");
final GridLayout innerGrid = new GridLayout();
innerGrid.marginLeft = 50;
innerGrid.marginRight = 50;
innerGrid.marginHeight = 0;
innerGrid.marginWidth = 0;
contentBackground.setLayout(innerGrid);
final Composite content = new Composite(contentBackground, SWT.NONE);
content.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
content.setData(RWT.CUSTOM_VARIANT, "content");
final GridLayout contentGrid = new GridLayout();
contentGrid.marginHeight = 0;
contentGrid.marginWidth = 0;
content.setLayout(contentGrid);
final Composite contentInner = new Composite(content, SWT.NONE);
contentInner.setLayoutData(new GridData(SWT.CENTER, SWT.CENTER, true, true));
final GridLayout gridLayout = new GridLayout();
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
contentInner.setLayout(gridLayout);
final String contentComposerName = pageContext.getAttribute(
AttributeKeys.PAGE_TEMPLATE_COMPOSER_NAME);
pageContext.composerService().compose(
contentComposerName,
pageContext.copyOf(contentInner));
}
private void composeFooter(final PageContext pageContext) {
final Composite footerBar = new Composite(pageContext.getParent(), SWT.NONE);
final GridData footerCell = new GridData(SWT.FILL, SWT.BOTTOM, false, false);
footerCell.minimumHeight = 30;
footerCell.heightHint = 30;
footerBar.setLayoutData(footerCell);
footerBar.setData(RWT.CUSTOM_VARIANT, "bgFooter");
final GridLayout innerBarGrid = new GridLayout();
innerBarGrid.marginHeight = 0;
innerBarGrid.marginWidth = 0;
innerBarGrid.marginLeft = 50;
innerBarGrid.marginRight = 50;
footerBar.setLayout(innerBarGrid);
final Composite footer = new Composite(footerBar, SWT.NONE);
final GridData gridData = new GridData(SWT.FILL, SWT.FILL, true, true);
footer.setLayoutData(gridData);
final GridLayout footerGrid = new GridLayout(2, false);
footerGrid.marginHeight = 0;
footerGrid.marginWidth = 0;
footerGrid.horizontalSpacing = 0;
footer.setLayout(footerGrid);
footer.setData(RWT.CUSTOM_VARIANT, "footer");
final Composite footerLeft = new Composite(footer, SWT.NONE);
footerLeft.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, true, true));
footerLeft.setData(RWT.CUSTOM_VARIANT, "footer");
RowLayout rowLayout = new RowLayout(SWT.HORIZONTAL);
rowLayout.marginLeft = 20;
rowLayout.spacing = 20;
footerLeft.setLayout(rowLayout);
final Composite footerRight = new Composite(footer, SWT.NONE);
footerRight.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, true, true));
footerRight.setData(RWT.CUSTOM_VARIANT, "footer");
rowLayout = new RowLayout(SWT.HORIZONTAL);
rowLayout.marginRight = 20;
footerRight.setLayout(rowLayout);
final I18nSupport i18nSupport = this.widgetFactory.getI18nSupport();
if (StringUtils.isNoneBlank(i18nSupport.getText(IMPRINT_TEXT_KEY, ""))) {
final Label imprint = this.widgetFactory.labelLocalized(
footerLeft,
CustomVariant.FOOTER,
IMPRINT_TEXT_KEY);
imprint.addListener(SWT.MouseUp, event -> {
try {
pageContext.publishPageMessage(IMPRINT_TEXT_KEY, IMPRINT_MARKUP_TEXT_KEY);
} catch (final Exception e) {
log.error("Invalid markup for 'Imprint'", e);
}
});
}
if (StringUtils.isNoneBlank(i18nSupport.getText(ABOUT_TEXT_KEY, ""))) {
final Label about = this.widgetFactory.labelLocalized(
footerLeft,
CustomVariant.FOOTER,
ABOUT_TEXT_KEY);
about.addListener(SWT.MouseUp, event -> {
try {
pageContext.publishPageMessage(ABOUT_TEXT_KEY, ABOUT_MARKUP_TEXT_KEY);
} catch (final Exception e) {
log.error("Invalid markup for 'About'", e);
}
});
}
if (StringUtils.isNoneBlank(i18nSupport.getText(HELP_TEXT_KEY, ""))) {
final Label help = this.widgetFactory.labelLocalized(
footerLeft,
CustomVariant.FOOTER,
HELP_TEXT_KEY);
help.addListener(SWT.MouseUp, event -> {
try {
final String link = i18nSupport.getText(HELP_LINK_TEXT_KEY, "");
if (StringUtils.isNoneBlank(link)) {
final UrlLauncher urlLauncher = RWT.getClient().getService(UrlLauncher.class);
urlLauncher.openURL(link);
}
} catch (final Exception e) {
log.error("Invalid Help link", e);
}
});
}
this.widgetFactory.labelLocalized(
footerRight,
CustomVariant.FOOTER,
new LocTextKey("sebserver.overall.version", this.sebServerVersion));
}
private void loadInstitutionalLogo(final PageContext pageContext, final Composite logo) {
logo.setData(RWT.CUSTOM_VARIANT, "bgLogo");
try {
final String imageBase64 = (String) RWT.getUISession()
.getHttpSession()
.getAttribute(API.PARAM_LOGO_IMAGE);
if (StringUtils.isBlank(imageBase64)) {
return;
}
final Base64InputStream input = new Base64InputStream(
new ByteArrayInputStream(imageBase64.getBytes(StandardCharsets.UTF_8)),
false);
final Display display = pageContext.getShell().getDisplay();
final Image image = new Image(display, input);
final Rectangle imageBounds = image.getBounds();
final int width = (imageBounds.width > LOGO_IMAGE_MAX_WIDTH)
? LOGO_IMAGE_MAX_WIDTH
: imageBounds.width;
final int height = (imageBounds.height > LOGO_IMAGE_MAX_HEIGHT)
? LOGO_IMAGE_MAX_HEIGHT
: imageBounds.height;
final ImageData imageData = image.getImageData().scaledTo(width, height);
logo.setData(RWT.CUSTOM_VARIANT, "bgLogoNoImage");
logo.setBackgroundImage(new Image(display, imageData));
} catch (final Exception e) {
log.warn("Get institutional logo failed: {}", e.getMessage());
}
}
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page.impl;
import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import org.apache.commons.codec.binary.Base64InputStream;
import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.client.service.UrlLauncher;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.ImageData;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.MessageBox;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.i18n.PolyglotPageService;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.service.page.PageContext.AttributeKeys;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.service.page.TemplateComposer;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.auth.AuthorizationContextHolder;
import ch.ethz.seb.sebserver.gui.widget.Message;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.CustomVariant;
@Lazy
@Component
public class DefaultPageLayout implements TemplateComposer {
private static final Logger log = LoggerFactory.getLogger(DefaultPageLayout.class);
private static final LocTextKey ABOUT_TEXT_KEY = new LocTextKey("sebserver.overall.about");
private static final LocTextKey IMPRINT_TEXT_KEY = new LocTextKey("sebserver.overall.imprint");
private static final LocTextKey HELP_TEXT_KEY = new LocTextKey("sebserver.overall.help");
private static final LocTextKey ABOUT_MARKUP_TEXT_KEY = new LocTextKey("sebserver.overall.about.markup");
private static final LocTextKey IMPRINT_MARKUP_TEXT_KEY = new LocTextKey("sebserver.overall.imprint.markup");
private static final LocTextKey HELP_LINK_TEXT_KEY = new LocTextKey("sebserver.overall.help.link");
public static final int LOGO_IMAGE_MAX_WIDTH = 400;
public static final int LOGO_IMAGE_MAX_HEIGHT = 80;
private final WidgetFactory widgetFactory;
private final PolyglotPageService polyglotPageService;
private final AuthorizationContextHolder authorizationContextHolder;
private final PageService pageService;
private final String sebServerVersion;
private final boolean multilingual;
public DefaultPageLayout(
final PageService pageService,
final Environment environment) {
this.widgetFactory = pageService.getWidgetFactory();
this.polyglotPageService = pageService.getPolyglotPageService();
this.authorizationContextHolder = pageService.getAuthorizationContextHolder();
this.pageService = pageService;
this.sebServerVersion = environment.getProperty("sebserver.version", Constants.EMPTY_NOTE);
this.multilingual = BooleanUtils.toBoolean(environment.getProperty("sebserver.gui.multilingual", "false"));
}
@Override
public boolean validate(final PageContext pageContext) {
return pageContext.hasAttribute(AttributeKeys.PAGE_TEMPLATE_COMPOSER_NAME);
}
@Override
public void compose(final PageContext pageContext) {
final GridLayout skeletonLayout = new GridLayout();
skeletonLayout.marginBottom = 0;
skeletonLayout.marginLeft = 0;
skeletonLayout.marginRight = 0;
skeletonLayout.marginTop = 0;
skeletonLayout.marginHeight = 0;
skeletonLayout.marginWidth = 0;
skeletonLayout.verticalSpacing = 0;
skeletonLayout.horizontalSpacing = 0;
pageContext.getParent().setLayout(skeletonLayout);
composeHeader(pageContext);
composeLogoBar(pageContext);
composeContent(pageContext);
composeFooter(pageContext);
this.polyglotPageService.setDefaultPageLocale(pageContext.getRoot());
}
private void composeHeader(final PageContext pageContext) {
final Composite header = new Composite(pageContext.getParent(), SWT.NONE);
final GridLayout gridLayout = new GridLayout();
gridLayout.marginRight = 50;
gridLayout.marginLeft = 50;
header.setLayout(gridLayout);
final GridData headerCell = new GridData(SWT.FILL, SWT.TOP, true, false);
headerCell.minimumHeight = 40;
headerCell.heightHint = 40;
header.setLayoutData(headerCell);
header.setData(RWT.CUSTOM_VARIANT, "header");
final Composite headerRight = new Composite(header, SWT.NONE);
headerRight.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, true, true));
final GridLayout headerRightGrid = new GridLayout(2, false);
headerRightGrid.marginHeight = 0;
headerRightGrid.marginWidth = 0;
headerRightGrid.horizontalSpacing = 20;
headerRight.setLayout(headerRightGrid);
headerRight.setData(RWT.CUSTOM_VARIANT, "header");
if (this.authorizationContextHolder.getAuthorizationContext().isLoggedIn()) {
final Label username = new Label(headerRight, SWT.NONE);
username.setData(RWT.CUSTOM_VARIANT, "header");
username.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, true, true));
username.setText(this.authorizationContextHolder
.getAuthorizationContext()
.getLoggedInUser()
.get(t -> this.pageService.logoutOnError(t, pageContext)).username);
final Button logout = this.widgetFactory.buttonLocalized(headerRight, "sebserver.logout");
logout.setLayoutData(new GridData(SWT.RIGHT, SWT.FILL, true, true));
logout.setData(RWT.CUSTOM_VARIANT, "header");
logout.addListener(SWT.Selection, event -> {
this.pageService.logout(pageContext);
// show successful logout message
final MessageBox logoutSuccess = new Message(
pageContext.getShell(),
this.polyglotPageService.getI18nSupport().getText("sebserver.logout"),
this.polyglotPageService.getI18nSupport().getText("sebserver.logout.success.message"),
SWT.ICON_INFORMATION,
pageContext.getI18nSupport());
logoutSuccess.open(null);
// TODO Try to invalidate RWT's user session.
// This seems to be more difficult then expected and just invalidate the HttpSession doesn't work
// Try to send a redirect JSON to the client: https://bugs.eclipse.org/bugs/show_bug.cgi?id=388249
});
}
}
private void composeLogoBar(final PageContext pageContext) {
final Composite logoBar = new Composite(pageContext.getParent(), SWT.NONE);
final GridData logoBarCell = new GridData(SWT.FILL, SWT.TOP, false, false);
logoBarCell.minimumHeight = 80;
logoBarCell.heightHint = 80;
logoBar.setLayoutData(logoBarCell);
logoBar.setData(RWT.CUSTOM_VARIANT, "logo");
final GridLayout logoBarLayout = new GridLayout(2, false);
logoBarLayout.horizontalSpacing = 0;
logoBarLayout.marginHeight = 0;
logoBar.setLayout(logoBarLayout);
final Composite logo = new Composite(logoBar, SWT.NONE);
final GridData logoCell = new GridData(SWT.LEFT, SWT.CENTER, true, true);
logoCell.minimumHeight = LOGO_IMAGE_MAX_HEIGHT;
logoCell.heightHint = LOGO_IMAGE_MAX_HEIGHT;
logoCell.minimumWidth = LOGO_IMAGE_MAX_WIDTH;
logoCell.horizontalIndent = 50;
logo.setLayoutData(logoCell);
// try to get institutional logo first. If no success, use default logo
loadInstitutionalLogo(pageContext, logo);
final Composite langSupport = new Composite(logoBar, SWT.NONE);
final GridData langSupportCell = new GridData(SWT.RIGHT, SWT.CENTER, false, false);
langSupportCell.heightHint = 20;
logoCell.horizontalIndent = 50;
langSupport.setLayoutData(langSupportCell);
langSupport.setData(RWT.CUSTOM_VARIANT, "logo");
final RowLayout rowLayout = new RowLayout(SWT.HORIZONTAL);
rowLayout.spacing = 7;
rowLayout.marginRight = 70;
langSupport.setLayout(rowLayout);
if (this.multilingual) {
this.polyglotPageService.createLanguageSelector(pageContext.copyOf(langSupport));
}
}
private void composeContent(final PageContext pageContext) {
final Composite contentBackground = new Composite(pageContext.getParent(), SWT.NONE);
contentBackground.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
contentBackground.setData(RWT.CUSTOM_VARIANT, "bgContent");
final GridLayout innerGrid = new GridLayout();
innerGrid.marginLeft = 50;
innerGrid.marginRight = 50;
innerGrid.marginHeight = 0;
innerGrid.marginWidth = 0;
contentBackground.setLayout(innerGrid);
final Composite content = new Composite(contentBackground, SWT.NONE);
content.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
content.setData(RWT.CUSTOM_VARIANT, "content");
final GridLayout contentGrid = new GridLayout();
contentGrid.marginHeight = 0;
contentGrid.marginWidth = 0;
content.setLayout(contentGrid);
final Composite contentInner = new Composite(content, SWT.NONE);
contentInner.setLayoutData(new GridData(SWT.CENTER, SWT.CENTER, true, true));
final GridLayout gridLayout = new GridLayout();
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
contentInner.setLayout(gridLayout);
final String contentComposerName = pageContext.getAttribute(
AttributeKeys.PAGE_TEMPLATE_COMPOSER_NAME);
pageContext.composerService().compose(
contentComposerName,
pageContext.copyOf(contentInner));
}
private void composeFooter(final PageContext pageContext) {
final Composite footerBar = new Composite(pageContext.getParent(), SWT.NONE);
final GridData footerCell = new GridData(SWT.FILL, SWT.BOTTOM, false, false);
footerCell.minimumHeight = 30;
footerCell.heightHint = 30;
footerBar.setLayoutData(footerCell);
footerBar.setData(RWT.CUSTOM_VARIANT, "bgFooter");
final GridLayout innerBarGrid = new GridLayout();
innerBarGrid.marginHeight = 0;
innerBarGrid.marginWidth = 0;
innerBarGrid.marginLeft = 50;
innerBarGrid.marginRight = 50;
footerBar.setLayout(innerBarGrid);
final Composite footer = new Composite(footerBar, SWT.NONE);
final GridData gridData = new GridData(SWT.FILL, SWT.FILL, true, true);
footer.setLayoutData(gridData);
final GridLayout footerGrid = new GridLayout(2, false);
footerGrid.marginHeight = 0;
footerGrid.marginWidth = 0;
footerGrid.horizontalSpacing = 0;
footer.setLayout(footerGrid);
footer.setData(RWT.CUSTOM_VARIANT, "footer");
final Composite footerLeft = new Composite(footer, SWT.NONE);
footerLeft.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, true, true));
footerLeft.setData(RWT.CUSTOM_VARIANT, "footer");
RowLayout rowLayout = new RowLayout(SWT.HORIZONTAL);
rowLayout.marginLeft = 20;
rowLayout.spacing = 20;
footerLeft.setLayout(rowLayout);
final Composite footerRight = new Composite(footer, SWT.NONE);
footerRight.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, true, true));
footerRight.setData(RWT.CUSTOM_VARIANT, "footer");
rowLayout = new RowLayout(SWT.HORIZONTAL);
rowLayout.marginRight = 20;
footerRight.setLayout(rowLayout);
final I18nSupport i18nSupport = this.widgetFactory.getI18nSupport();
if (StringUtils.isNoneBlank(i18nSupport.getText(IMPRINT_TEXT_KEY, ""))) {
final Label imprint = this.widgetFactory.labelLocalized(
footerLeft,
CustomVariant.FOOTER,
IMPRINT_TEXT_KEY);
imprint.addListener(SWT.MouseUp, event -> {
try {
pageContext.publishPageMessage(IMPRINT_TEXT_KEY, IMPRINT_MARKUP_TEXT_KEY);
} catch (final Exception e) {
log.error("Invalid markup for 'Imprint'", e);
}
});
}
if (StringUtils.isNoneBlank(i18nSupport.getText(ABOUT_TEXT_KEY, ""))) {
final Label about = this.widgetFactory.labelLocalized(
footerLeft,
CustomVariant.FOOTER,
ABOUT_TEXT_KEY);
about.addListener(SWT.MouseUp, event -> {
try {
pageContext.publishPageMessage(ABOUT_TEXT_KEY, ABOUT_MARKUP_TEXT_KEY);
} catch (final Exception e) {
log.error("Invalid markup for 'About'", e);
}
});
}
if (StringUtils.isNoneBlank(i18nSupport.getText(HELP_TEXT_KEY, ""))) {
final Label help = this.widgetFactory.labelLocalized(
footerLeft,
CustomVariant.FOOTER,
HELP_TEXT_KEY);
help.addListener(SWT.MouseUp, event -> {
try {
final String link = i18nSupport.getText(HELP_LINK_TEXT_KEY, "");
if (StringUtils.isNoneBlank(link)) {
final UrlLauncher urlLauncher = RWT.getClient().getService(UrlLauncher.class);
urlLauncher.openURL(link);
}
} catch (final Exception e) {
log.error("Invalid Help link", e);
}
});
}
this.widgetFactory.labelLocalized(
footerRight,
CustomVariant.FOOTER,
new LocTextKey("sebserver.overall.version", this.sebServerVersion));
}
private void loadInstitutionalLogo(final PageContext pageContext, final Composite logo) {
logo.setData(RWT.CUSTOM_VARIANT, "bgLogo");
try {
final String imageBase64 = (String) RWT.getUISession()
.getHttpSession()
.getAttribute(API.PARAM_LOGO_IMAGE);
if (StringUtils.isBlank(imageBase64)) {
return;
}
final Base64InputStream input = new Base64InputStream(
new ByteArrayInputStream(imageBase64.getBytes(StandardCharsets.UTF_8)),
false);
final Display display = pageContext.getShell().getDisplay();
final Image image = new Image(display, input);
final Rectangle imageBounds = image.getBounds();
final int width = Math.min(imageBounds.width, LOGO_IMAGE_MAX_WIDTH);
final int height = Math.min(imageBounds.height, LOGO_IMAGE_MAX_HEIGHT);
final ImageData imageData = image.getImageData().scaledTo(width, height);
logo.setData(RWT.CUSTOM_VARIANT, "bgLogoNoImage");
logo.setBackgroundImage(new Image(display, imageData));
} catch (final Exception e) {
log.warn("Get institutional logo failed: {}", e.getMessage());
}
}
}

445
src/main/java/ch/ethz/seb/sebserver/gui/service/page/impl/ModalInputDialog.java
View file

@ -1,225 +1,220 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page.impl;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.function.Supplier;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Dialog;
import org.eclipse.swt.widgets.Shell;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.page.ModalInputDialogComposer;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.CustomVariant;
public class ModalInputDialog<T> extends Dialog {
private static final long serialVersionUID = -3448614119078234374L;
public static final int DEFAULT_DIALOG_WIDTH = 400;
public static final int DEFAULT_DIALOG_HEIGHT = 600;
public static final int DEFAULT_DIALOG_BUTTON_WIDTH = 100;
public static final int LARGE_DIALOG_WIDTH = 600;
public static final int VERY_LARGE_DIALOG_WIDTH = 800;
private static final LocTextKey CANCEL_TEXT_KEY =
new LocTextKey("sebserver.overall.action.cancel");
private static final LocTextKey OK_TEXT_KEY =
new LocTextKey("sebserver.overall.action.ok");
private static final LocTextKey CLOSE_TEXT_KEY =
new LocTextKey("sebserver.overall.action.close");
private final WidgetFactory widgetFactory;
private int dialogWidth = DEFAULT_DIALOG_WIDTH;
private int dialogHeight = DEFAULT_DIALOG_HEIGHT;
private int buttonWidth = DEFAULT_DIALOG_BUTTON_WIDTH;
public ModalInputDialog(
final Shell parent,
final WidgetFactory widgetFactory) {
super(parent, SWT.BORDER | SWT.TITLE | SWT.APPLICATION_MODAL | SWT.CLOSE);
this.widgetFactory = widgetFactory;
}
public ModalInputDialog<T> setDialogWidth(final int dialogWidth) {
this.dialogWidth = dialogWidth;
return this;
}
public ModalInputDialog<T> setLargeDialogWidth() {
this.dialogWidth = LARGE_DIALOG_WIDTH;
return this;
}
public ModalInputDialog<T> setVeryLargeDialogWidth() {
this.dialogWidth = VERY_LARGE_DIALOG_WIDTH;
return this;
}
public ModalInputDialog<T> setDialogHeight(final int dialogHeight) {
this.dialogHeight = dialogHeight;
return this;
}
public ModalInputDialog<T> setButtonWidth(final int buttonWidth) {
this.buttonWidth = buttonWidth;
return this;
}
public void open(
final LocTextKey title,
final ModalInputDialogComposer<T> contentComposer) {
open(
title,
(Predicate<T>) t -> true,
() -> {
}, contentComposer);
}
public void open(
final LocTextKey title,
final Consumer<T> callback,
final Runnable cancelCallback,
final ModalInputDialogComposer<T> contentComposer) {
final Predicate<T> predicate = result -> {
callback.accept(result);
return true;
};
open(title, predicate, cancelCallback, contentComposer);
}
public void open(
final LocTextKey title,
final Predicate<T> callback,
final Runnable cancelCallback,
final ModalInputDialogComposer<T> contentComposer) {
// Create the selection dialog window
final Shell shell = new Shell(getParent(), getStyle());
shell.setText(getText());
shell.setData(RWT.CUSTOM_VARIANT, CustomVariant.MESSAGE.key);
shell.setText(this.widgetFactory.getI18nSupport().getText(title));
shell.setLayout(new GridLayout(2, true));
final GridData gridData2 = new GridData(SWT.FILL, SWT.TOP, false, false);
shell.setLayoutData(gridData2);
final Composite main = new Composite(shell, SWT.NONE);
main.setLayout(new GridLayout());
final GridData gridData = new GridData(SWT.FILL, SWT.FILL, true, true);
gridData.horizontalSpan = 2;
gridData.widthHint = this.dialogWidth;
main.setLayoutData(gridData);
final Supplier<T> valueSuppier = contentComposer.compose(main);
gridData.heightHint = calcDialogHeight(main);
final Button ok = this.widgetFactory.buttonLocalized(shell, OK_TEXT_KEY);
GridData data = new GridData(GridData.HORIZONTAL_ALIGN_END);
data.widthHint = this.buttonWidth;
ok.setLayoutData(data);
ok.addListener(SWT.Selection, event -> {
if (valueSuppier != null) {
final T result = valueSuppier.get();
if (callback.test(result)) {
shell.close();
}
} else {
shell.close();
}
});
shell.setDefaultButton(ok);
final Button cancel = this.widgetFactory.buttonLocalized(shell, CANCEL_TEXT_KEY);
data = new GridData(GridData.HORIZONTAL_ALIGN_BEGINNING);
data.widthHint = this.buttonWidth;
cancel.setLayoutData(data);
cancel.addListener(SWT.Selection, event -> {
if (cancelCallback != null) {
cancelCallback.run();
}
shell.close();
});
finishUp(shell);
}
public void open(
final LocTextKey title,
final PageContext pageContext,
final Consumer<PageContext> contentComposer) {
// Create the info dialog window
final Shell shell = new Shell(getParent(), getStyle());
shell.setText(getText());
shell.setData(RWT.CUSTOM_VARIANT, CustomVariant.MESSAGE.key);
shell.setText(this.widgetFactory.getI18nSupport().getText(title));
shell.setLayout(new GridLayout());
final GridData gridData2 = new GridData(SWT.FILL, SWT.TOP, true, true);
shell.setLayoutData(gridData2);
final Composite main = new Composite(shell, SWT.NONE);
main.setLayout(new GridLayout());
final GridData gridData = new GridData(SWT.FILL, SWT.TOP, true, true);
gridData.widthHint = this.dialogWidth;
main.setLayoutData(gridData);
contentComposer.accept(pageContext.copyOf(main));
gridData.heightHint = calcDialogHeight(main);
final Button close = this.widgetFactory.buttonLocalized(shell, CLOSE_TEXT_KEY);
final GridData data = new GridData(GridData.HORIZONTAL_ALIGN_CENTER);
data.widthHint = this.buttonWidth;
close.setLayoutData(data);
close.addListener(SWT.Selection, event -> {
shell.close();
});
finishUp(shell);
}
private void finishUp(final Shell shell) {
shell.pack();
final Rectangle bounds = shell.getBounds();
final Rectangle bounds2 = super.getParent().getDisplay().getBounds();
bounds.x = (bounds2.width - bounds.width) / 2;
bounds.y = (bounds2.height - bounds.height) / 2;
shell.setBounds(bounds);
shell.open();
}
private int calcDialogHeight(final Composite main) {
final int actualHeight = main.computeSize(SWT.DEFAULT, SWT.DEFAULT).y;
final int displayHeight = main.getDisplay().getClientArea().height;
final int availableHeight = (displayHeight < actualHeight + 100)
? displayHeight - 100
: actualHeight;
final int height = (availableHeight > this.dialogHeight)
? this.dialogHeight
: availableHeight;
return height;
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page.impl;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.function.Supplier;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Dialog;
import org.eclipse.swt.widgets.Shell;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.page.ModalInputDialogComposer;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.CustomVariant;
public class ModalInputDialog<T> extends Dialog {
private static final long serialVersionUID = -3448614119078234374L;
public static final int DEFAULT_DIALOG_WIDTH = 400;
public static final int DEFAULT_DIALOG_HEIGHT = 600;
public static final int DEFAULT_DIALOG_BUTTON_WIDTH = 100;
public static final int LARGE_DIALOG_WIDTH = 600;
public static final int VERY_LARGE_DIALOG_WIDTH = 800;
private static final LocTextKey CANCEL_TEXT_KEY =
new LocTextKey("sebserver.overall.action.cancel");
private static final LocTextKey OK_TEXT_KEY =
new LocTextKey("sebserver.overall.action.ok");
private static final LocTextKey CLOSE_TEXT_KEY =
new LocTextKey("sebserver.overall.action.close");
private final WidgetFactory widgetFactory;
private int dialogWidth = DEFAULT_DIALOG_WIDTH;
private int dialogHeight = DEFAULT_DIALOG_HEIGHT;
private int buttonWidth = DEFAULT_DIALOG_BUTTON_WIDTH;
public ModalInputDialog(
final Shell parent,
final WidgetFactory widgetFactory) {
super(parent, SWT.BORDER | SWT.TITLE | SWT.APPLICATION_MODAL | SWT.CLOSE);
this.widgetFactory = widgetFactory;
}
public ModalInputDialog<T> setDialogWidth(final int dialogWidth) {
this.dialogWidth = dialogWidth;
return this;
}
public ModalInputDialog<T> setLargeDialogWidth() {
this.dialogWidth = LARGE_DIALOG_WIDTH;
return this;
}
public ModalInputDialog<T> setVeryLargeDialogWidth() {
this.dialogWidth = VERY_LARGE_DIALOG_WIDTH;
return this;
}
public ModalInputDialog<T> setDialogHeight(final int dialogHeight) {
this.dialogHeight = dialogHeight;
return this;
}
public ModalInputDialog<T> setButtonWidth(final int buttonWidth) {
this.buttonWidth = buttonWidth;
return this;
}
public void open(
final LocTextKey title,
final ModalInputDialogComposer<T> contentComposer) {
open(
title,
t -> true,
() -> {
}, contentComposer);
}
public void open(
final LocTextKey title,
final Consumer<T> callback,
final Runnable cancelCallback,
final ModalInputDialogComposer<T> contentComposer) {
final Predicate<T> predicate = result -> {
callback.accept(result);
return true;
};
open(title, predicate, cancelCallback, contentComposer);
}
public void open(
final LocTextKey title,
final Predicate<T> callback,
final Runnable cancelCallback,
final ModalInputDialogComposer<T> contentComposer) {
// Create the selection dialog window
final Shell shell = new Shell(getParent(), getStyle());
shell.setText(getText());
shell.setData(RWT.CUSTOM_VARIANT, CustomVariant.MESSAGE.key);
shell.setText(this.widgetFactory.getI18nSupport().getText(title));
shell.setLayout(new GridLayout(2, true));
final GridData gridData2 = new GridData(SWT.FILL, SWT.TOP, false, false);
shell.setLayoutData(gridData2);
final Composite main = new Composite(shell, SWT.NONE);
main.setLayout(new GridLayout());
final GridData gridData = new GridData(SWT.FILL, SWT.FILL, true, true);
gridData.horizontalSpan = 2;
gridData.widthHint = this.dialogWidth;
main.setLayoutData(gridData);
final Supplier<T> valueSupplier = contentComposer.compose(main);
gridData.heightHint = calcDialogHeight(main);
final Button ok = this.widgetFactory.buttonLocalized(shell, OK_TEXT_KEY);
GridData data = new GridData(GridData.HORIZONTAL_ALIGN_END);
data.widthHint = this.buttonWidth;
ok.setLayoutData(data);
ok.addListener(SWT.Selection, event -> {
if (valueSupplier != null) {
final T result = valueSupplier.get();
if (callback.test(result)) {
shell.close();
}
} else {
shell.close();
}
});
shell.setDefaultButton(ok);
final Button cancel = this.widgetFactory.buttonLocalized(shell, CANCEL_TEXT_KEY);
data = new GridData(GridData.HORIZONTAL_ALIGN_BEGINNING);
data.widthHint = this.buttonWidth;
cancel.setLayoutData(data);
cancel.addListener(SWT.Selection, event -> {
if (cancelCallback != null) {
cancelCallback.run();
}
shell.close();
});
finishUp(shell);
}
public void open(
final LocTextKey title,
final PageContext pageContext,
final Consumer<PageContext> contentComposer) {
// Create the info dialog window
final Shell shell = new Shell(getParent(), getStyle());
shell.setText(getText());
shell.setData(RWT.CUSTOM_VARIANT, CustomVariant.MESSAGE.key);
shell.setText(this.widgetFactory.getI18nSupport().getText(title));
shell.setLayout(new GridLayout());
final GridData gridData2 = new GridData(SWT.FILL, SWT.TOP, true, true);
shell.setLayoutData(gridData2);
final Composite main = new Composite(shell, SWT.NONE);
main.setLayout(new GridLayout());
final GridData gridData = new GridData(SWT.FILL, SWT.TOP, true, true);
gridData.widthHint = this.dialogWidth;
main.setLayoutData(gridData);
contentComposer.accept(pageContext.copyOf(main));
gridData.heightHint = calcDialogHeight(main);
final Button close = this.widgetFactory.buttonLocalized(shell, CLOSE_TEXT_KEY);
final GridData data = new GridData(GridData.HORIZONTAL_ALIGN_CENTER);
data.widthHint = this.buttonWidth;
close.setLayoutData(data);
close.addListener(SWT.Selection, event -> shell.close());
finishUp(shell);
}
private void finishUp(final Shell shell) {
shell.pack();
final Rectangle bounds = shell.getBounds();
final Rectangle bounds2 = super.getParent().getDisplay().getBounds();
bounds.x = (bounds2.width - bounds.width) / 2;
bounds.y = (bounds2.height - bounds.height) / 2;
shell.setBounds(bounds);
shell.open();
}
private int calcDialogHeight(final Composite main) {
final int actualHeight = main.computeSize(SWT.DEFAULT, SWT.DEFAULT).y;
final int displayHeight = main.getDisplay().getClientArea().height;
final int availableHeight = (displayHeight < actualHeight + 100)
? displayHeight - 100
: actualHeight;
return Math.min(availableHeight, this.dialogHeight);
}
}

686
src/main/java/ch/ethz/seb/sebserver/gui/service/page/impl/PageContextImpl.java
View file

@ -1,346 +1,340 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page.impl;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import org.apache.commons.lang3.BooleanUtils;
import org.eclipse.rap.rwt.widgets.DialogCallback;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.MessageBox;
import org.eclipse.swt.widgets.Shell;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.api.APIMessageError;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.model.EntityKey;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.page.ComposerService;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.service.page.PageDefinition;
import ch.ethz.seb.sebserver.gui.service.page.PageMessageException;
import ch.ethz.seb.sebserver.gui.widget.Message;
public class PageContextImpl implements PageContext {
private static final Logger log = LoggerFactory.getLogger(PageContextImpl.class);
private final I18nSupport i18nSupport;
private final ComposerService composerService;
private final Composite root;
private final Composite parent;
private final Map<String, String> attributes;
PageContextImpl(
final I18nSupport i18nSupport,
final ComposerService composerService,
final Composite root,
final Composite parent,
final Map<String, String> attributes) {
this.i18nSupport = i18nSupport;
this.composerService = composerService;
this.root = root;
this.parent = parent;
this.attributes = Utils.immutableMapOf(attributes);
}
@Override
public I18nSupport getI18nSupport() {
return this.i18nSupport;
}
@Override
public Shell getShell() {
if (this.root == null) {
return null;
}
return this.root.getShell();
}
@Override
public ComposerService composerService() {
return this.composerService;
}
@Override
public Composite getRoot() {
return this.root;
}
@Override
public Composite getParent() {
return this.parent;
}
@Override
public PageContext copy() {
return copyOf(this.parent);
}
@Override
public PageContext copyOf(final Composite parent) {
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
parent,
new HashMap<>(this.attributes));
}
@Override
public PageContext copyOfAttributes(final PageContext otherContext) {
final Map<String, String> attrs = new HashMap<>();
attrs.putAll(this.attributes);
attrs.putAll(((PageContextImpl) otherContext).attributes);
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
this.parent,
attrs);
}
@Override
public PageContext withAttribute(final String key, final String value) {
final Map<String, String> attrs = new HashMap<>();
attrs.putAll(this.attributes);
attrs.put(key, value);
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
this.parent,
attrs);
}
@Override
public String getAttribute(final String name) {
return this.attributes.get(name);
}
@Override
public String getAttribute(final String name, final String def) {
if (this.attributes.containsKey(name)) {
return this.attributes.get(name);
} else {
return def;
}
}
@Override
public boolean isReadonly() {
return BooleanUtils.toBoolean(getAttribute(AttributeKeys.READ_ONLY, "true"));
}
@Override
public EntityKey getEntityKey() {
if (hasAttribute(AttributeKeys.ENTITY_ID) && hasAttribute(AttributeKeys.ENTITY_TYPE)) {
return new EntityKey(
getAttribute(AttributeKeys.ENTITY_ID),
EntityType.valueOf(getAttribute(AttributeKeys.ENTITY_TYPE)));
}
return null;
}
@Override
public EntityKey getParentEntityKey() {
if (hasAttribute(AttributeKeys.PARENT_ENTITY_ID) && hasAttribute(AttributeKeys.PARENT_ENTITY_TYPE)) {
return new EntityKey(
getAttribute(AttributeKeys.PARENT_ENTITY_ID),
EntityType.valueOf(getAttribute(AttributeKeys.PARENT_ENTITY_TYPE)));
}
return null;
}
@Override
public PageContext withEntityKey(final EntityKey entityKey) {
if (entityKey == null) {
return removeAttribute(AttributeKeys.ENTITY_ID)
.removeAttribute(AttributeKeys.ENTITY_TYPE);
}
return withAttribute(AttributeKeys.ENTITY_ID, entityKey.modelId)
.withAttribute(AttributeKeys.ENTITY_TYPE, entityKey.entityType.name());
}
@Override
public PageContext withParentEntityKey(final EntityKey entityKey) {
if (entityKey == null) {
return removeAttribute(AttributeKeys.PARENT_ENTITY_ID)
.removeAttribute(AttributeKeys.PARENT_ENTITY_TYPE);
}
return withAttribute(AttributeKeys.PARENT_ENTITY_ID, entityKey.modelId)
.withAttribute(AttributeKeys.PARENT_ENTITY_TYPE, entityKey.entityType.name());
}
@Override
public PageContext clearEntityKeys() {
return withEntityKey(null)
.withParentEntityKey(null);
}
@Override
public boolean hasAttribute(final String name) {
return this.attributes.containsKey(name);
}
@Override
public PageContext removeAttribute(final String name) {
final Map<String, String> attrs = new HashMap<>();
attrs.putAll(this.attributes);
attrs.remove(name);
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
this.parent,
attrs);
}
@Override
public PageContext clearAttributes() {
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
this.parent,
null);
}
@Override
public void applyConfirmDialog(final LocTextKey confirmMessage, final Consumer<Boolean> callback) {
final Message messageBox = new Message(
this.root.getShell(),
this.i18nSupport.getText("sebserver.dialog.confirm.title"),
this.i18nSupport.getText(confirmMessage),
SWT.OK | SWT.CANCEL,
this.i18nSupport);
messageBox.setMarkupEnabled(true);
messageBox.open(new ConfirmDialogCallback(callback));
}
@Override
public void forwardToPage(final PageDefinition pageDefinition) {
this.composerService.compose(
pageDefinition.composer(),
pageDefinition.applyPageContext(copyOf(this.root)));
}
@Override
public void forwardToMainPage() {
forwardToPage(this.composerService.mainPage());
}
@Override
public void forwardToLoginPage() {
this.clearAttributes()
.forwardToPage(this.composerService.loginPage());
}
@Override
public void publishPageMessage(final LocTextKey title, final LocTextKey message) {
final MessageBox messageBox = new Message(
getShell(),
(title != null)
? this.i18nSupport.getText(title)
: "",
this.i18nSupport.getText(message),
SWT.NONE,
this.i18nSupport);
messageBox.setMarkupEnabled(true);
messageBox.open(null);
}
@Override
public void publishPageMessage(final PageMessageException pme) {
final MessageBox messageBox = new Message(
getShell(),
this.i18nSupport.getText("sebserver.page.message"),
this.i18nSupport.getText(pme.getMessageKey()),
SWT.NONE,
this.i18nSupport);
messageBox.setMarkupEnabled(true);
messageBox.open(null);
}
@Override
public void notifyError(final LocTextKey message, final Exception error) {
log.error("Unexpected GUI error notified: {}", error.getMessage());
final String errorMessage = message != null
? this.i18nSupport.getText(message)
: error.getMessage();
if (error instanceof APIMessageError) {
final List<APIMessage> errorMessages = ((APIMessageError) error).getErrorMessages();
final MessageBox messageBox = new Message(
getShell(),
this.i18nSupport.getText("sebserver.error.unexpected"),
APIMessage.toHTML(errorMessage, errorMessages),
SWT.ERROR,
this.i18nSupport);
messageBox.setMarkupEnabled(true);
messageBox.open(null);
return;
}
final MessageBox messageBox = new Message(
getShell(),
this.i18nSupport.getText("sebserver.error.unexpected"),
Utils.formatHTMLLines(errorMessage + "<br/><br/> Cause: " + error.getMessage()),
SWT.ERROR,
this.i18nSupport);
messageBox.open(null);
}
@Override
public String toString() {
return "PageContextImpl [root=" + this.root + ", parent=" + this.parent + ", attributes=" + this.attributes
+ "]";
}
private static final class ConfirmDialogCallback implements DialogCallback {
private static final long serialVersionUID = 1491270214433492441L;
private final Consumer<Boolean> onOK;
private ConfirmDialogCallback(final Consumer<Boolean> onOK) {
this.onOK = onOK;
}
@Override
public void dialogClosed(final int returnCode) {
if (returnCode == SWT.OK) {
try {
this.onOK.accept(true);
} catch (final Exception e) {
log.error(
"Unexpected on confirm callback execution. This should not happen, plase secure the given onOK Runnable",
e);
this.onOK.accept(false);
}
} else {
this.onOK.accept(false);
}
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.page.impl;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import org.apache.commons.lang3.BooleanUtils;
import org.eclipse.rap.rwt.widgets.DialogCallback;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.MessageBox;
import org.eclipse.swt.widgets.Shell;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.api.APIMessageError;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.model.EntityKey;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.page.ComposerService;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.service.page.PageDefinition;
import ch.ethz.seb.sebserver.gui.service.page.PageMessageException;
import ch.ethz.seb.sebserver.gui.widget.Message;
public class PageContextImpl implements PageContext {
private static final Logger log = LoggerFactory.getLogger(PageContextImpl.class);
private final I18nSupport i18nSupport;
private final ComposerService composerService;
private final Composite root;
private final Composite parent;
private final Map<String, String> attributes;
PageContextImpl(
final I18nSupport i18nSupport,
final ComposerService composerService,
final Composite root,
final Composite parent,
final Map<String, String> attributes) {
this.i18nSupport = i18nSupport;
this.composerService = composerService;
this.root = root;
this.parent = parent;
this.attributes = Utils.immutableMapOf(attributes);
}
@Override
public I18nSupport getI18nSupport() {
return this.i18nSupport;
}
@Override
public Shell getShell() {
if (this.root == null) {
return null;
}
return this.root.getShell();
}
@Override
public ComposerService composerService() {
return this.composerService;
}
@Override
public Composite getRoot() {
return this.root;
}
@Override
public Composite getParent() {
return this.parent;
}
@Override
public PageContext copy() {
return copyOf(this.parent);
}
@Override
public PageContext copyOf(final Composite parent) {
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
parent,
new HashMap<>(this.attributes));
}
@Override
public PageContext copyOfAttributes(final PageContext otherContext) {
final Map<String, String> attrs = new HashMap<>();
attrs.putAll(this.attributes);
attrs.putAll(((PageContextImpl) otherContext).attributes);
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
this.parent,
attrs);
}
@Override
public PageContext withAttribute(final String key, final String value) {
final Map<String, String> attrs = new HashMap<>(this.attributes);
attrs.put(key, value);
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
this.parent,
attrs);
}
@Override
public String getAttribute(final String name) {
return this.attributes.get(name);
}
@Override
public String getAttribute(final String name, final String def) {
return this.attributes.getOrDefault(name, def);
}
@Override
public boolean isReadonly() {
return BooleanUtils.toBoolean(getAttribute(AttributeKeys.READ_ONLY, "true"));
}
@Override
public EntityKey getEntityKey() {
if (hasAttribute(AttributeKeys.ENTITY_ID) && hasAttribute(AttributeKeys.ENTITY_TYPE)) {
return new EntityKey(
getAttribute(AttributeKeys.ENTITY_ID),
EntityType.valueOf(getAttribute(AttributeKeys.ENTITY_TYPE)));
}
return null;
}
@Override
public EntityKey getParentEntityKey() {
if (hasAttribute(AttributeKeys.PARENT_ENTITY_ID) && hasAttribute(AttributeKeys.PARENT_ENTITY_TYPE)) {
return new EntityKey(
getAttribute(AttributeKeys.PARENT_ENTITY_ID),
EntityType.valueOf(getAttribute(AttributeKeys.PARENT_ENTITY_TYPE)));
}
return null;
}
@Override
public PageContext withEntityKey(final EntityKey entityKey) {
if (entityKey == null) {
return removeAttribute(AttributeKeys.ENTITY_ID)
.removeAttribute(AttributeKeys.ENTITY_TYPE);
}
return withAttribute(AttributeKeys.ENTITY_ID, entityKey.modelId)
.withAttribute(AttributeKeys.ENTITY_TYPE, entityKey.entityType.name());
}
@Override
public PageContext withParentEntityKey(final EntityKey entityKey) {
if (entityKey == null) {
return removeAttribute(AttributeKeys.PARENT_ENTITY_ID)
.removeAttribute(AttributeKeys.PARENT_ENTITY_TYPE);
}
return withAttribute(AttributeKeys.PARENT_ENTITY_ID, entityKey.modelId)
.withAttribute(AttributeKeys.PARENT_ENTITY_TYPE, entityKey.entityType.name());
}
@Override
public PageContext clearEntityKeys() {
return withEntityKey(null)
.withParentEntityKey(null);
}
@Override
public boolean hasAttribute(final String name) {
return this.attributes.containsKey(name);
}
@Override
public PageContext removeAttribute(final String name) {
final Map<String, String> attrs = new HashMap<>(this.attributes);
attrs.remove(name);
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
this.parent,
attrs);
}
@Override
public PageContext clearAttributes() {
return new PageContextImpl(
this.i18nSupport,
this.composerService,
this.root,
this.parent,
null);
}
@Override
public void applyConfirmDialog(final LocTextKey confirmMessage, final Consumer<Boolean> callback) {
final Message messageBox = new Message(
this.root.getShell(),
this.i18nSupport.getText("sebserver.dialog.confirm.title"),
this.i18nSupport.getText(confirmMessage),
SWT.OK | SWT.CANCEL,
this.i18nSupport);
messageBox.setMarkupEnabled(true);
messageBox.open(new ConfirmDialogCallback(callback));
}
@Override
public void forwardToPage(final PageDefinition pageDefinition) {
this.composerService.compose(
pageDefinition.composer(),
pageDefinition.applyPageContext(copyOf(this.root)));
}
@Override
public void forwardToMainPage() {
forwardToPage(this.composerService.mainPage());
}
@Override
public void forwardToLoginPage() {
this.clearAttributes()
.forwardToPage(this.composerService.loginPage());
}
@Override
public void publishPageMessage(final LocTextKey title, final LocTextKey message) {
final MessageBox messageBox = new Message(
getShell(),
(title != null)
? this.i18nSupport.getText(title)
: "",
this.i18nSupport.getText(message),
SWT.NONE,
this.i18nSupport);
messageBox.setMarkupEnabled(true);
messageBox.open(null);
}
@Override
public void publishPageMessage(final PageMessageException pme) {
final MessageBox messageBox = new Message(
getShell(),
this.i18nSupport.getText("sebserver.page.message"),
this.i18nSupport.getText(pme.getMessageKey()),
SWT.NONE,
this.i18nSupport);
messageBox.setMarkupEnabled(true);
messageBox.open(null);
}
@Override
public void notifyError(final LocTextKey message, final Exception error) {
log.error("Unexpected GUI error notified: {}", error.getMessage());
final String errorMessage = message != null
? this.i18nSupport.getText(message)
: error.getMessage();
if (error instanceof APIMessageError) {
final List<APIMessage> errorMessages = ((APIMessageError) error).getErrorMessages();
final MessageBox messageBox = new Message(
getShell(),
this.i18nSupport.getText("sebserver.error.unexpected"),
APIMessage.toHTML(errorMessage, errorMessages),
SWT.ERROR,
this.i18nSupport);
messageBox.setMarkupEnabled(true);
messageBox.open(null);
return;
}
final MessageBox messageBox = new Message(
getShell(),
this.i18nSupport.getText("sebserver.error.unexpected"),
Utils.formatHTMLLines(errorMessage + "<br/><br/> Cause: " + error.getMessage()),
SWT.ERROR,
this.i18nSupport);
messageBox.open(null);
}
@Override
public String toString() {
return "PageContextImpl [root=" + this.root + ", parent=" + this.parent + ", attributes=" + this.attributes
+ "]";
}
private static final class ConfirmDialogCallback implements DialogCallback {
private static final long serialVersionUID = 1491270214433492441L;
private final Consumer<Boolean> onOK;
private ConfirmDialogCallback(final Consumer<Boolean> onOK) {
this.onOK = onOK;
}
@Override
public void dialogClosed(final int returnCode) {
if (returnCode == SWT.OK) {
try {
this.onOK.accept(true);
} catch (final Exception e) {
log.error(
"Unexpected on confirm callback execution. This should not happen, please secure the given onOK Runnable",
e);
this.onOK.accept(false);
}
} else {
this.onOK.accept(false);
}
}
}
}

4
src/main/java/ch/ethz/seb/sebserver/gui/service/page/impl/PageServiceImpl.java
View file

@ -227,7 +227,7 @@ public class PageServiceImpl implements PageService {
final int dependencies = (int) entities.stream()
.flatMap(entity -> {
final RestCall<Set<EntityKey>>.RestCallBuilder builder =
restService.<Set<EntityKey>>getBuilder(
restService.getBuilder(
entity.entityType(),
CallType.GET_DEPENDENCIES);
@ -366,7 +366,7 @@ public class PageServiceImpl implements PageService {
final boolean logoutSuccessful = this.currentUser.logout();
if (!logoutSuccessful) {
log.warn("Failed to logout. See logfiles for more information");
log.warn("Failed to logout. See log-files for more information");
}
} catch (final Exception e) {

208
src/main/java/ch/ethz/seb/sebserver/gui/service/push/ServerPushService.java
View file

@ -1,104 +1,104 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.push;
import java.util.function.Consumer;
import org.eclipse.rap.rwt.service.ServerPushSession;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Service;
/** Puts RAP's server-push functionality in a well defined service by using a context
* as state holder and the possibility to split the server-push process into two
* separated processes, a business-process to get and update business data and the
* an update-process to update the UI after according to updated data */
@Lazy
@Service
public class ServerPushService {
private static final Logger log = LoggerFactory.getLogger(ServerPushService.class);
public void runServerPush(
final ServerPushContext context,
final long intervalPause,
final Consumer<ServerPushContext> update) {
this.runServerPush(context, intervalPause, null, update);
}
public void runServerPush(
final ServerPushContext context,
final long intervalPause,
final Consumer<ServerPushContext> business,
final Consumer<ServerPushContext> update) {
final ServerPushSession pushSession = new ServerPushSession();
pushSession.start();
final Thread bgThread = new Thread(() -> {
while (!context.isDisposed() && context.runAgain()) {
try {
Thread.sleep(intervalPause);
} catch (final Exception e) {
if (log.isDebugEnabled()) {
log.debug("unexpected error while sleep: ", e);
}
}
if (business != null) {
try {
log.trace("Call business on Server Push Session on: {}", Thread.currentThread().getName());
business.accept(context);
} catch (final Exception e) {
log.error("Unexpected error while do business for server push service", e);
if (context.runAgain()) {
continue;
} else {
return;
}
}
}
if (!context.isDisposed()) {
log.trace("Call update on Server Push Session on: {}", Thread.currentThread().getName());
context.getDisplay().asyncExec(() -> {
try {
update.accept(context);
} catch (final Exception e) {
log.warn(
"Failed to update on Server Push Session {}. It seems that the UISession is not available anymore. "
+ "This may source from a connection interruption.",
Thread.currentThread().getName(), e.getMessage());
}
});
}
}
log.info("Stop Server Push Session on: {}", Thread.currentThread().getName());
try {
pushSession.stop();
} catch (final Exception e) {
log.warn(
"Failed to stop Server Push Session on: {}. It seems that the UISession is not available anymore. This may source from a connection interruption",
Thread.currentThread().getName(), e);
}
});
log.info("Start new Server Push Session on: {}", bgThread.getName());
bgThread.setDaemon(true);
bgThread.start();
}
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.push;
import java.util.function.Consumer;
import org.eclipse.rap.rwt.service.ServerPushSession;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Service;
/** Puts RAP's server-push functionality in a well defined service by using a context
* as state holder and the possibility to split the server-push process into two
* separated processes, a business-process to get and update business data and the
* an update-process to update the UI after according to updated data */
@Lazy
@Service
public class ServerPushService {
private static final Logger log = LoggerFactory.getLogger(ServerPushService.class);
public void runServerPush(
final ServerPushContext context,
final long intervalPause,
final Consumer<ServerPushContext> update) {
this.runServerPush(context, intervalPause, null, update);
}
public void runServerPush(
final ServerPushContext context,
final long intervalPause,
final Consumer<ServerPushContext> business,
final Consumer<ServerPushContext> update) {
final ServerPushSession pushSession = new ServerPushSession();
pushSession.start();
final Thread bgThread = new Thread(() -> {
while (!context.isDisposed() && context.runAgain()) {
try {
Thread.sleep(intervalPause);
} catch (final Exception e) {
if (log.isDebugEnabled()) {
log.debug("unexpected error while sleep: ", e);
}
}
if (business != null) {
try {
log.trace("Call business on Server Push Session on: {}", Thread.currentThread().getName());
business.accept(context);
} catch (final Exception e) {
log.error("Unexpected error while do business for server push service", e);
if (context.runAgain()) {
continue;
} else {
return;
}
}
}
if (!context.isDisposed()) {
log.trace("Call update on Server Push Session on: {}", Thread.currentThread().getName());
context.getDisplay().asyncExec(() -> {
try {
update.accept(context);
} catch (final Exception e) {
log.warn(
"Failed to update on Server Push Session {}. It seems that the UISession is not available anymore. "
+ "This may source from a connection interruption. cause: {}",
Thread.currentThread().getName(), e.getMessage());
}
});
}
}
log.info("Stop Server Push Session on: {}", Thread.currentThread().getName());
try {
pushSession.stop();
} catch (final Exception e) {
log.warn(
"Failed to stop Server Push Session on: {}. It seems that the UISession is not available anymore. This may source from a connection interruption",
Thread.currentThread().getName(), e);
}
});
log.info("Start new Server Push Session on: {}", bgThread.getName());
bgThread.setDaemon(true);
bgThread.start();
}
}

235
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/download/DownloadService.java
View file

@ -1,119 +1,116 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import java.io.IOException;
import java.util.Collection;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.service.ServiceHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Service;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
@Lazy
@Service
@GuiProfile
public class DownloadService implements ServiceHandler {
private static final Logger log = LoggerFactory.getLogger(DownloadService.class);
public static final String DOWNLOAD_SERVICE_NAME = "DOWNLOAD_SERVICE";
public static final String HANDLER_NAME_PARAMETER = "download-handler-name";
public static final String DOWNLOAD_FILE_NAME = "download-file-name";
private final Map<String, DownloadServiceHandler> handler;
protected DownloadService(final Collection<DownloadServiceHandler> handler) {
this.handler = handler
.stream()
.collect(Collectors.toMap(
h -> h.getClass().getSimpleName(),
Function.identity()));
}
@Override
public void service(
final HttpServletRequest request,
final HttpServletResponse response) throws IOException, ServletException {
log.debug("Received download service request: {}", request.getRequestURI());
final String handlerName = request.getParameter(HANDLER_NAME_PARAMETER);
if (StringUtils.isBlank(handlerName)) {
log.error("Missing request parameter {}. Ignoring download service request",
HANDLER_NAME_PARAMETER);
return;
}
if (!this.handler.containsKey(handlerName)) {
log.error("Missing DownloadServiceHandler with name {}. Ignoring download service request",
handlerName);
return;
}
this.handler
.get(handlerName)
.processDownload(request, response);
}
public String createDownloadURL(
final String modelId,
final Class<? extends DownloadServiceHandler> handlerClass,
final String downloadFileName) {
return createDownloadURL(modelId, null, handlerClass, downloadFileName);
}
public String createDownloadURL(
final String modelId,
final String parentModelId,
final Class<? extends DownloadServiceHandler> handlerClass,
final String downloadFileName) {
final StringBuilder url = new StringBuilder()
.append(RWT.getServiceManager()
.getServiceHandlerUrl(DownloadService.DOWNLOAD_SERVICE_NAME))
.append(Constants.FORM_URL_ENCODED_SEPARATOR)
.append(API.PARAM_MODEL_ID)
.append(Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR)
.append(modelId)
.append(Constants.FORM_URL_ENCODED_SEPARATOR)
.append(DownloadService.HANDLER_NAME_PARAMETER)
.append(Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR)
.append(handlerClass.getSimpleName())
.append(Constants.FORM_URL_ENCODED_SEPARATOR)
.append(DownloadService.DOWNLOAD_FILE_NAME)
.append(Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR)
.append(downloadFileName);
if (StringUtils.isNotBlank(parentModelId)) {
url.append(Constants.FORM_URL_ENCODED_SEPARATOR)
.append(API.PARAM_PARENT_MODEL_ID)
.append(Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR)
.append(parentModelId);
}
return url.toString();
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.service.ServiceHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Service;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Collection;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;
/** Implements a eclipse RAP ServiceHandler to handle downloads */
@Lazy
@Service
@GuiProfile
public class DownloadService implements ServiceHandler {
private static final Logger log = LoggerFactory.getLogger(DownloadService.class);
public static final String DOWNLOAD_SERVICE_NAME = "DOWNLOAD_SERVICE";
public static final String HANDLER_NAME_PARAMETER = "download-handler-name";
public static final String DOWNLOAD_FILE_NAME = "download-file-name";
private final Map<String, DownloadServiceHandler> handler;
protected DownloadService(final Collection<DownloadServiceHandler> handler) {
this.handler = handler
.stream()
.collect(Collectors.toMap(
h -> h.getClass().getSimpleName(),
Function.identity()));
}
@Override
public void service(
final HttpServletRequest request,
final HttpServletResponse response) {
log.debug("Received download service request: {}", request.getRequestURI());
final String handlerName = request.getParameter(HANDLER_NAME_PARAMETER);
if (StringUtils.isBlank(handlerName)) {
log.error("Missing request parameter {}. Ignoring download service request",
HANDLER_NAME_PARAMETER);
return;
}
if (!this.handler.containsKey(handlerName)) {
log.error("Missing DownloadServiceHandler with name {}. Ignoring download service request",
handlerName);
return;
}
this.handler
.get(handlerName)
.processDownload(request, response);
}
public String createDownloadURL(
final String modelId,
final Class<? extends DownloadServiceHandler> handlerClass,
final String downloadFileName) {
return createDownloadURL(modelId, null, handlerClass, downloadFileName);
}
public String createDownloadURL(
final String modelId,
final String parentModelId,
final Class<? extends DownloadServiceHandler> handlerClass,
final String downloadFileName) {
final StringBuilder url = new StringBuilder()
.append(RWT.getServiceManager()
.getServiceHandlerUrl(DownloadService.DOWNLOAD_SERVICE_NAME))
.append(Constants.FORM_URL_ENCODED_SEPARATOR)
.append(API.PARAM_MODEL_ID)
.append(Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR)
.append(modelId)
.append(Constants.FORM_URL_ENCODED_SEPARATOR)
.append(DownloadService.HANDLER_NAME_PARAMETER)
.append(Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR)
.append(handlerClass.getSimpleName())
.append(Constants.FORM_URL_ENCODED_SEPARATOR)
.append(DownloadService.DOWNLOAD_FILE_NAME)
.append(Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR)
.append(downloadFileName);
if (StringUtils.isNotBlank(parentModelId)) {
url.append(Constants.FORM_URL_ENCODED_SEPARATOR)
.append(API.PARAM_PARENT_MODEL_ID)
.append(Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR)
.append(parentModelId);
}
return url.toString();
}
}

41
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/download/DownloadServiceHandler.java
View file

@ -1,18 +1,23 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public interface DownloadServiceHandler {
void processDownload(final HttpServletRequest request, final HttpServletResponse response);
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/** Interface defining a service to handle downloads */
public interface DownloadServiceHandler {
/** Process a requested download
*
* @param request The download HttpServletRequest
* @param response the response to send the download to */
void processDownload(final HttpServletRequest request, final HttpServletResponse response);
}

138
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/download/SebClientConfigDownload.java
View file

@ -1,69 +1,69 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.seb.clientconfig.ExportClientConfig;
@Lazy
@Component
@GuiProfile
public class SebClientConfigDownload extends AbstractDownloadServiceHandler {
private static final Logger log = LoggerFactory.getLogger(SebClientConfigDownload.class);
private final RestService restService;
public final String downloadFileName;
protected SebClientConfigDownload(
final RestService restService,
@Value("${sebserver.gui.seb.client.config.download.filename}") final String downloadFileName) {
this.restService = restService;
this.downloadFileName = downloadFileName;
}
@Override
protected void webserviceCall(final String modelId, final String parentModelId, final OutputStream downloadOut) {
final InputStream input = this.restService.getBuilder(ExportClientConfig.class)
.withURIVariable(API.PARAM_MODEL_ID, modelId)
.call()
.getOrThrow();
try {
IOUtils.copyLarge(input, downloadOut);
} catch (final IOException e) {
log.error(
"Unexpected error while streaming incomming config data from web-service to output-stream of download response: ",
e);
} finally {
try {
downloadOut.flush();
downloadOut.close();
} catch (final IOException e) {
log.error("Unexpected error while trying to close download output-stream");
}
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.seb.clientconfig.ExportClientConfig;
@Lazy
@Component
@GuiProfile
public class SebClientConfigDownload extends AbstractDownloadServiceHandler {
private static final Logger log = LoggerFactory.getLogger(SebClientConfigDownload.class);
private final RestService restService;
public final String downloadFileName;
protected SebClientConfigDownload(
final RestService restService,
@Value("${sebserver.gui.seb.client.config.download.filename}") final String downloadFileName) {
this.restService = restService;
this.downloadFileName = downloadFileName;
}
@Override
protected void webserviceCall(final String modelId, final String parentModelId, final OutputStream downloadOut) {
final InputStream input = this.restService.getBuilder(ExportClientConfig.class)
.withURIVariable(API.PARAM_MODEL_ID, modelId)
.call()
.getOrThrow();
try {
IOUtils.copyLarge(input, downloadOut);
} catch (final IOException e) {
log.error(
"Unexpected error while streaming incoming config data from web-service to output-stream of download response: ",
e);
} finally {
try {
downloadOut.flush();
downloadOut.close();
} catch (final IOException e) {
log.error("Unexpected error while trying to close download output-stream");
}
}
}
}

128
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/download/SebExamConfigDownload.java
View file

@ -1,64 +1,64 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.exam.ExportExamConfig;
@Lazy
@Component
@GuiProfile
public class SebExamConfigDownload extends AbstractDownloadServiceHandler {
private static final Logger log = LoggerFactory.getLogger(SebExamConfigDownload.class);
private final RestService restService;
protected SebExamConfigDownload(final RestService restService) {
this.restService = restService;
}
@Override
protected void webserviceCall(final String modelId, final String parentModelId, final OutputStream downloadOut) {
final InputStream input = this.restService.getBuilder(ExportExamConfig.class)
.withURIVariable(API.PARAM_MODEL_ID, modelId)
.withURIVariable(API.PARAM_PARENT_MODEL_ID, parentModelId)
.call()
.getOrThrow();
try {
IOUtils.copyLarge(input, downloadOut);
} catch (final IOException e) {
log.error(
"Unexpected error while streaming incomming config data from web-service to output-stream of download response: ",
e);
} finally {
try {
downloadOut.flush();
downloadOut.close();
} catch (final IOException e) {
log.error("Unexpected error while trying to close download output-stream");
}
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.exam.ExportExamConfig;
@Lazy
@Component
@GuiProfile
public class SebExamConfigDownload extends AbstractDownloadServiceHandler {
private static final Logger log = LoggerFactory.getLogger(SebExamConfigDownload.class);
private final RestService restService;
protected SebExamConfigDownload(final RestService restService) {
this.restService = restService;
}
@Override
protected void webserviceCall(final String modelId, final String parentModelId, final OutputStream downloadOut) {
final InputStream input = this.restService.getBuilder(ExportExamConfig.class)
.withURIVariable(API.PARAM_MODEL_ID, modelId)
.withURIVariable(API.PARAM_PARENT_MODEL_ID, parentModelId)
.call()
.getOrThrow();
try {
IOUtils.copyLarge(input, downloadOut);
} catch (final IOException e) {
log.error(
"Unexpected error while streaming incoming config data from web-service to output-stream of download response: ",
e);
} finally {
try {
downloadOut.flush();
downloadOut.close();
} catch (final IOException e) {
log.error("Unexpected error while trying to close download output-stream");
}
}
}
}

126
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/download/SebExamConfigPlaintextDownload.java
View file

@ -1,63 +1,63 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.seb.examconfig.ExportPlainXML;
@Lazy
@Component
@GuiProfile
public class SebExamConfigPlaintextDownload extends AbstractDownloadServiceHandler {
private static final Logger log = LoggerFactory.getLogger(SebExamConfigPlaintextDownload.class);
private final RestService restService;
protected SebExamConfigPlaintextDownload(final RestService restService) {
this.restService = restService;
}
@Override
protected void webserviceCall(final String modelId, final String parentModelId, final OutputStream downloadOut) {
final InputStream input = this.restService.getBuilder(ExportPlainXML.class)
.withURIVariable(API.PARAM_MODEL_ID, modelId)
.call()
.getOrThrow();
try {
IOUtils.copyLarge(input, downloadOut);
} catch (final IOException e) {
log.error(
"Unexpected error while streaming incomming config data from web-service to output-stream of download response: ",
e);
} finally {
try {
downloadOut.flush();
downloadOut.close();
} catch (final IOException e) {
log.error("Unexpected error while trying to close download output-stream");
}
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.download;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.seb.examconfig.ExportPlainXML;
@Lazy
@Component
@GuiProfile
public class SebExamConfigPlaintextDownload extends AbstractDownloadServiceHandler {
private static final Logger log = LoggerFactory.getLogger(SebExamConfigPlaintextDownload.class);
private final RestService restService;
protected SebExamConfigPlaintextDownload(final RestService restService) {
this.restService = restService;
}
@Override
protected void webserviceCall(final String modelId, final String parentModelId, final OutputStream downloadOut) {
final InputStream input = this.restService.getBuilder(ExportPlainXML.class)
.withURIVariable(API.PARAM_MODEL_ID, modelId)
.call()
.getOrThrow();
try {
IOUtils.copyLarge(input, downloadOut);
} catch (final IOException e) {
log.error(
"Unexpected error while streaming incoming config data from web-service to output-stream of download response: ",
e);
} finally {
try {
downloadOut.flush();
downloadOut.close();
} catch (final IOException e) {
log.error("Unexpected error while trying to close download output-stream");
}
}
}
}

94
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/api/AbstractExportCall.java
View file

@ -1,49 +1,45 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
import java.io.InputStream;
import org.apache.commons.io.IOUtils;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpRequest;
import ch.ethz.seb.sebserver.gbl.util.Result;
public abstract class AbstractExportCall extends RestCall<InputStream> {
protected AbstractExportCall(
final TypeKey<InputStream> typeKey,
final HttpMethod httpMethod,
final MediaType contentType,
final String path) {
super(typeKey, httpMethod, contentType, path);
}
@Override
protected Result<InputStream> exchange(final RestCallBuilder builder) {
return Result.tryCatch(() -> {
return builder
.getRestTemplate()
.execute(
builder.buildURI(),
this.httpMethod,
(final ClientHttpRequest requestCallback) -> {
},
response -> IOUtils.toBufferedInputStream(response.getBody()),
builder.getURIVariables());
});
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
import java.io.InputStream;
import org.apache.commons.io.IOUtils;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpRequest;
import ch.ethz.seb.sebserver.gbl.util.Result;
public abstract class AbstractExportCall extends RestCall<InputStream> {
protected AbstractExportCall(
final TypeKey<InputStream> typeKey,
final HttpMethod httpMethod,
final MediaType contentType,
final String path) {
super(typeKey, httpMethod, contentType, path);
}
@Override
protected Result<InputStream> exchange(final RestCallBuilder builder) {
return Result.tryCatch(() -> builder
.getRestTemplate()
.execute(
builder.buildURI(),
this.httpMethod,
(final ClientHttpRequest requestCallback) -> {
},
response -> IOUtils.toBufferedInputStream(response.getBody()),
builder.getURIVariables()));
}
}

42
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/api/FormBinding.java
View file

@ -1,17 +1,25 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
public interface FormBinding {
String getFormAsJson();
String getFormUrlEncoded();
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
/** Defines a form binding to get form parameter and values either in JSON format
* or as form-url-encoded string */
public interface FormBinding {
/** Get the form parameter and values in JSON format
*
* @return the form parameter and values in JSON format */
String getFormAsJson();
/** Get the form parameter and values in form-url-encoded string format.
*
* @return the form parameter and values in form-url-encoded string format.*/
String getFormUrlEncoded();
}

842
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/api/RestCall.java
View file

@ -1,422 +1,420 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.io.InputStreamResource;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestClientResponseException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponentsBuilder;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonMappingException;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.api.JSONMapper;
import ch.ethz.seb.sebserver.gbl.model.Entity;
import ch.ethz.seb.sebserver.gbl.model.Page;
import ch.ethz.seb.sebserver.gbl.model.PageSortOrder;
import ch.ethz.seb.sebserver.gbl.util.Result;
import ch.ethz.seb.sebserver.gbl.util.Utils;
public abstract class RestCall<T> {
private static final Logger log = LoggerFactory.getLogger(RestCall.class);
public enum CallType {
UNDEFINED,
GET_SINGLE,
GET_PAGE,
GET_NAMES,
GET_DEPENDENCIES,
GET_LIST,
NEW,
REGISTER,
SAVE,
DELETE,
ACTIVATION_ACTIVATE,
ACTIVATION_DEACTIVATE
}
protected RestService restService;
protected JSONMapper jsonMapper;
protected TypeKey<T> typeKey;
protected final HttpMethod httpMethod;
protected final MediaType contentType;
protected final String path;
protected RestCall(
final TypeKey<T> typeKey,
final HttpMethod httpMethod,
final MediaType contentType,
final String path) {
this.typeKey = typeKey;
this.httpMethod = httpMethod;
this.contentType = contentType;
this.path = path;
}
protected RestCall<T> init(
final RestService restService,
final JSONMapper jsonMapper) {
this.restService = restService;
this.jsonMapper = jsonMapper;
return this;
}
public EntityType getEntityType() {
if (this.typeKey != null) {
return this.typeKey.entityType;
}
return null;
}
protected Result<T> exchange(final RestCallBuilder builder) {
log.debug("Call webservice API on {} for {}", this.path, builder);
try {
final ResponseEntity<String> responseEntity = builder.restTemplate
.exchange(
builder.buildURI(),
this.httpMethod,
builder.buildRequestEntity(),
String.class,
builder.uriVariables);
if (responseEntity.getStatusCode() == HttpStatus.OK) {
if (log.isTraceEnabled()) {
log.trace("response body --> {}" + responseEntity.getBody());
}
if (!responseEntity.hasBody()) {
return Result.ofEmpty();
}
return Result.of(RestCall.this.jsonMapper.readValue(
responseEntity.getBody(),
RestCall.this.typeKey.typeRef));
} else {
return handleRestCallError(responseEntity);
}
} catch (final RestClientResponseException responseError) {
final RestCallError restCallError = new RestCallError("Unexpected error while rest call", responseError);
try {
final String responseBody = responseError.getResponseBodyAsString();
restCallError.errors.addAll(RestCall.this.jsonMapper.readValue(
responseBody,
new TypeReference<List<APIMessage>>() {
}));
} catch (final IOException e) {
restCallError.errors.add(APIMessage.ErrorMessage.UNEXPECTED.of(
responseError,
"NO RESPONSE AVAILABLE" + " cause: " + e.getMessage(),
String.valueOf(builder)));
}
return Result.ofError(restCallError);
} catch (final Exception e) {
final RestCallError restCallError = new RestCallError("Unexpected error while rest call", e);
restCallError.errors.add(APIMessage.ErrorMessage.UNEXPECTED.of(
e,
"NO RESPONSE AVAILABLE",
String.valueOf(builder)));
return Result.ofError(e);
}
}
public RestCallBuilder newBuilder() {
return new RestCallBuilder(
this.restService.getWebserviceAPIRestTemplate(),
this.restService.getWebserviceURIBuilder());
}
public RestCall<T>.RestCallBuilder newBuilder(final RestCall<?>.RestCallBuilder builder) {
return new RestCallBuilder(builder);
}
private Result<T> handleRestCallError(final ResponseEntity<String> responseEntity)
throws IOException, JsonParseException, JsonMappingException {
final RestCallError restCallError =
new RestCallError("Response Entity: " + responseEntity.toString());
try {
restCallError.errors.addAll(RestCall.this.jsonMapper.readValue(
responseEntity.getBody(),
new TypeReference<List<APIMessage>>() {
}));
} catch (final JsonParseException jpe) {
if (responseEntity.getStatusCode() == HttpStatus.UNAUTHORIZED) {
restCallError.errors.add(APIMessage.ErrorMessage.UNAUTHORIZED.of(responseEntity.getBody()));
} else {
restCallError.errors.add(APIMessage.ErrorMessage.GENERIC.of(responseEntity.getBody()));
}
}
log.debug(
"Webservice answered with well defined error- or validation-failure-response: ",
restCallError);
return Result.ofError(restCallError);
}
public class RestCallBuilder {
private RestTemplate restTemplate;
private UriComponentsBuilder uriComponentsBuilder;
private final HttpHeaders httpHeaders;
private String body = null;
private InputStream streamingBody = null;
private final MultiValueMap<String, String> queryParams;
private final Map<String, String> uriVariables;
protected RestCallBuilder(final RestTemplate restTemplate, final UriComponentsBuilder uriComponentsBuilder) {
this.restTemplate = restTemplate;
this.uriComponentsBuilder = uriComponentsBuilder;
this.httpHeaders = new HttpHeaders();
this.queryParams = new LinkedMultiValueMap<>();
this.uriVariables = new HashMap<>();
this.httpHeaders.set(
HttpHeaders.CONTENT_TYPE,
RestCall.this.contentType.toString());
}
public RestCallBuilder(final RestCall<?>.RestCallBuilder builder) {
this.restTemplate = builder.restTemplate;
this.uriComponentsBuilder = builder.uriComponentsBuilder;
this.httpHeaders = builder.httpHeaders;
this.body = builder.body;
this.queryParams = new LinkedMultiValueMap<>(builder.queryParams);
this.uriVariables = new HashMap<>(builder.uriVariables);
}
public RestTemplate getRestTemplate() {
return this.restTemplate;
}
public RestCallBuilder withRestTemplate(final RestTemplate restTemplate) {
this.restTemplate = restTemplate;
return this;
}
public RestCallBuilder withUriComponentsBuilder(final UriComponentsBuilder uriComponentsBuilder) {
this.uriComponentsBuilder = uriComponentsBuilder;
return this;
}
public RestCallBuilder withHeaders(final HttpHeaders headers) {
this.httpHeaders.addAll(headers);
return this;
}
public RestCallBuilder withHeader(final String name, final String value) {
this.httpHeaders.set(name, value);
return this;
}
public RestCallBuilder withHeaders(final MultiValueMap<String, String> params) {
this.httpHeaders.addAll(params);
return this;
}
public RestCallBuilder apply(final Function<RestCallBuilder, RestCallBuilder> f) {
return f.apply(this);
}
public RestCallBuilder withBody(final Object body) {
if (body == null) {
this.body = null;
return this;
}
if (body instanceof String) {
this.body = String.valueOf(body);
return this;
}
if (body instanceof InputStream) {
this.streamingBody = (InputStream) body;
return this;
}
try {
this.body = RestCall.this.jsonMapper.writeValueAsString(body);
} catch (final JsonProcessingException e) {
log.error("Error while trying to parse body json object: " + body);
}
return this;
}
public RestCallBuilder withURIVariable(final String name, final String value) {
this.uriVariables.put(name, value);
return this;
}
public RestCallBuilder withQueryParam(final String name, final String value) {
this.queryParams.put(name, Arrays.asList(value));
return this;
}
public RestCallBuilder withQueryParams(final MultiValueMap<String, String> params) {
if (params != null) {
this.queryParams.putAll(params);
}
return this;
}
public RestCallBuilder withFormParam(final String name, final String value) {
final String encodedVal = Utils.encodeFormURL_UTF_8(value);
if (StringUtils.isBlank(this.body)) {
this.body = name + Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR + encodedVal;
} else {
this.body = this.body + Constants.FORM_URL_ENCODED_SEPARATOR + name +
Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR + encodedVal;
}
return this;
}
public RestCallBuilder withPaging(final int pageNumber, final int pageSize) {
this.queryParams.put(Page.ATTR_PAGE_NUMBER, Arrays.asList(String.valueOf(pageNumber)));
this.queryParams.put(Page.ATTR_PAGE_SIZE, Arrays.asList(String.valueOf(pageSize)));
return this;
}
public RestCallBuilder withSorting(final String column, final PageSortOrder order) {
if (column != null) {
this.queryParams.put(Page.ATTR_SORT, Arrays.asList(order.encode(column)));
}
return this;
}
public RestCallBuilder withFormBinding(final FormBinding formBinding) {
if (RestCall.this.httpMethod == HttpMethod.PUT) {
return withBody(formBinding.getFormAsJson());
} else {
this.body = formBinding.getFormUrlEncoded();
return this;
}
}
public RestCallBuilder onlyActive(final boolean active) {
this.queryParams.put(Entity.FILTER_ATTR_ACTIVE, Arrays.asList(String.valueOf(active)));
return this;
}
public final Result<T> call() {
return RestCall.this.exchange(this);
}
public String buildURI() {
return this.uriComponentsBuilder
.cloneBuilder()
.path(RestCall.this.path)
.queryParams(this.queryParams)
.toUriString();
}
public HttpEntity<?> buildRequestEntity() {
if (this.streamingBody != null) {
return new HttpEntity<>(new InputStreamResource(this.streamingBody), this.httpHeaders);
} else if (this.body != null) {
return new HttpEntity<>(this.body, this.httpHeaders);
} else {
return new HttpEntity<>(this.httpHeaders);
}
}
public Map<String, String> getURIVariables() {
return Utils.immutableMapOf(this.uriVariables);
}
@Override
public String toString() {
return "RestCallBuilder [httpHeaders=" + this.httpHeaders + ", body=" + this.body + ", queryParams="
+ this.queryParams
+ ", uriVariables=" + this.uriVariables + "]";
}
}
public static final class TypeKey<T> {
final CallType callType;
final EntityType entityType;
private final TypeReference<T> typeRef;
public TypeKey(
final CallType callType,
final EntityType entityType,
final TypeReference<T> typeRef) {
this.callType = callType;
this.entityType = entityType;
this.typeRef = typeRef;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((this.callType == null) ? 0 : this.callType.hashCode());
result = prime * result + ((this.entityType == null) ? 0 : this.entityType.hashCode());
return result;
}
@Override
public boolean equals(final Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
final TypeKey<?> other = (TypeKey<?>) obj;
if (this.callType != other.callType)
return false;
if (this.entityType != other.entityType)
return false;
return true;
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.api.JSONMapper;
import ch.ethz.seb.sebserver.gbl.model.Entity;
import ch.ethz.seb.sebserver.gbl.model.Page;
import ch.ethz.seb.sebserver.gbl.model.PageSortOrder;
import ch.ethz.seb.sebserver.gbl.util.Result;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.io.InputStreamResource;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestClientResponseException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponentsBuilder;
import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
public abstract class RestCall<T> {
private static final Logger log = LoggerFactory.getLogger(RestCall.class);
public enum CallType {
UNDEFINED,
GET_SINGLE,
GET_PAGE,
GET_NAMES,
GET_DEPENDENCIES,
GET_LIST,
NEW,
REGISTER,
SAVE,
DELETE,
ACTIVATION_ACTIVATE,
ACTIVATION_DEACTIVATE
}
protected RestService restService;
protected JSONMapper jsonMapper;
protected TypeKey<T> typeKey;
protected final HttpMethod httpMethod;
protected final MediaType contentType;
protected final String path;
protected RestCall(
final TypeKey<T> typeKey,
final HttpMethod httpMethod,
final MediaType contentType,
final String path) {
this.typeKey = typeKey;
this.httpMethod = httpMethod;
this.contentType = contentType;
this.path = path;
}
protected RestCall<T> init(
final RestService restService,
final JSONMapper jsonMapper) {
this.restService = restService;
this.jsonMapper = jsonMapper;
return this;
}
public EntityType getEntityType() {
if (this.typeKey != null) {
return this.typeKey.entityType;
}
return null;
}
protected Result<T> exchange(final RestCallBuilder builder) {
log.debug("Call webservice API on {} for {}", this.path, builder);
try {
final ResponseEntity<String> responseEntity = builder.restTemplate
.exchange(
builder.buildURI(),
this.httpMethod,
builder.buildRequestEntity(),
String.class,
builder.uriVariables);
if (responseEntity.getStatusCode() == HttpStatus.OK) {
if (log.isTraceEnabled()) {
log.trace("response body --> {}" + responseEntity.getBody());
}
if (!responseEntity.hasBody()) {
return Result.ofEmpty();
}
return Result.of(RestCall.this.jsonMapper.readValue(
responseEntity.getBody(),
RestCall.this.typeKey.typeRef));
} else {
return handleRestCallError(responseEntity);
}
} catch (final RestClientResponseException responseError) {
final RestCallError restCallError = new RestCallError("Unexpected error while rest call", responseError);
try {
final String responseBody = responseError.getResponseBodyAsString();
restCallError.errors.addAll(RestCall.this.jsonMapper.readValue(
responseBody,
new TypeReference<List<APIMessage>>() {
}));
} catch (final IOException e) {
restCallError.errors.add(APIMessage.ErrorMessage.UNEXPECTED.of(
responseError,
"NO RESPONSE AVAILABLE" + " cause: " + e.getMessage(),
String.valueOf(builder)));
}
return Result.ofError(restCallError);
} catch (final Exception e) {
final RestCallError restCallError = new RestCallError("Unexpected error while rest call", e);
restCallError.errors.add(APIMessage.ErrorMessage.UNEXPECTED.of(
e,
"NO RESPONSE AVAILABLE",
String.valueOf(builder)));
return Result.ofError(e);
}
}
public RestCallBuilder newBuilder() {
return new RestCallBuilder(
this.restService.getWebserviceAPIRestTemplate(),
this.restService.getWebserviceURIBuilder());
}
public RestCall<T>.RestCallBuilder newBuilder(final RestCall<?>.RestCallBuilder builder) {
return new RestCallBuilder(builder);
}
private Result<T> handleRestCallError(final ResponseEntity<String> responseEntity)
throws IOException {
final RestCallError restCallError =
new RestCallError("Response Entity: " + responseEntity.toString());
try {
restCallError.errors.addAll(RestCall.this.jsonMapper.readValue(
responseEntity.getBody(),
new TypeReference<List<APIMessage>>() {
}));
} catch (final JsonParseException jpe) {
if (responseEntity.getStatusCode() == HttpStatus.UNAUTHORIZED) {
restCallError.errors.add(APIMessage.ErrorMessage.UNAUTHORIZED.of(responseEntity.getBody()));
} else {
restCallError.errors.add(APIMessage.ErrorMessage.GENERIC.of(responseEntity.getBody()));
}
}
log.debug(
"Webservice answered with well defined error- or validation-failure-response: ",
restCallError);
return Result.ofError(restCallError);
}
public class RestCallBuilder {
private RestTemplate restTemplate;
private UriComponentsBuilder uriComponentsBuilder;
private final HttpHeaders httpHeaders;
private String body = null;
private InputStream streamingBody = null;
private final MultiValueMap<String, String> queryParams;
private final Map<String, String> uriVariables;
protected RestCallBuilder(final RestTemplate restTemplate, final UriComponentsBuilder uriComponentsBuilder) {
this.restTemplate = restTemplate;
this.uriComponentsBuilder = uriComponentsBuilder;
this.httpHeaders = new HttpHeaders();
this.queryParams = new LinkedMultiValueMap<>();
this.uriVariables = new HashMap<>();
this.httpHeaders.set(
HttpHeaders.CONTENT_TYPE,
RestCall.this.contentType.toString());
}
public RestCallBuilder(final RestCall<?>.RestCallBuilder builder) {
this.restTemplate = builder.restTemplate;
this.uriComponentsBuilder = builder.uriComponentsBuilder;
this.httpHeaders = builder.httpHeaders;
this.body = builder.body;
this.streamingBody = builder.streamingBody;
this.queryParams = new LinkedMultiValueMap<>(builder.queryParams);
this.uriVariables = new HashMap<>(builder.uriVariables);
}
public RestTemplate getRestTemplate() {
return this.restTemplate;
}
public RestCallBuilder withRestTemplate(final RestTemplate restTemplate) {
this.restTemplate = restTemplate;
return this;
}
public RestCallBuilder withUriComponentsBuilder(final UriComponentsBuilder uriComponentsBuilder) {
this.uriComponentsBuilder = uriComponentsBuilder;
return this;
}
public RestCallBuilder withHeaders(final HttpHeaders headers) {
this.httpHeaders.addAll(headers);
return this;
}
public RestCallBuilder withHeader(final String name, final String value) {
this.httpHeaders.set(name, value);
return this;
}
public RestCallBuilder withHeaders(final MultiValueMap<String, String> params) {
this.httpHeaders.addAll(params);
return this;
}
public RestCallBuilder apply(final Function<RestCallBuilder, RestCallBuilder> f) {
return f.apply(this);
}
public RestCallBuilder withBody(final Object body) {
if (body == null) {
this.body = null;
return this;
}
if (body instanceof String) {
this.body = String.valueOf(body);
return this;
}
if (body instanceof InputStream) {
this.streamingBody = (InputStream) body;
return this;
}
try {
this.body = RestCall.this.jsonMapper.writeValueAsString(body);
} catch (final JsonProcessingException e) {
log.error("Error while trying to parse body json object: " + body);
}
return this;
}
public RestCallBuilder withURIVariable(final String name, final String value) {
this.uriVariables.put(name, value);
return this;
}
public RestCallBuilder withQueryParam(final String name, final String value) {
this.queryParams.put(name, Arrays.asList(value));
return this;
}
public RestCallBuilder withQueryParams(final MultiValueMap<String, String> params) {
if (params != null) {
this.queryParams.putAll(params);
}
return this;
}
public RestCallBuilder withFormParam(final String name, final String value) {
final String encodedVal = Utils.encodeFormURL_UTF_8(value);
if (StringUtils.isBlank(this.body)) {
this.body = name + Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR + encodedVal;
} else {
this.body = this.body + Constants.FORM_URL_ENCODED_SEPARATOR + name +
Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR + encodedVal;
}
return this;
}
public RestCallBuilder withPaging(final int pageNumber, final int pageSize) {
this.queryParams.put(Page.ATTR_PAGE_NUMBER, Arrays.asList(String.valueOf(pageNumber)));
this.queryParams.put(Page.ATTR_PAGE_SIZE, Arrays.asList(String.valueOf(pageSize)));
return this;
}
public RestCallBuilder withSorting(final String column, final PageSortOrder order) {
if (column != null) {
this.queryParams.put(Page.ATTR_SORT, Arrays.asList(order.encode(column)));
}
return this;
}
public RestCallBuilder withFormBinding(final FormBinding formBinding) {
if (RestCall.this.httpMethod == HttpMethod.PUT) {
return withBody(formBinding.getFormAsJson());
} else {
this.body = formBinding.getFormUrlEncoded();
return this;
}
}
public RestCallBuilder onlyActive(final boolean active) {
this.queryParams.put(Entity.FILTER_ATTR_ACTIVE, Arrays.asList(String.valueOf(active)));
return this;
}
public final Result<T> call() {
return RestCall.this.exchange(this);
}
public String buildURI() {
return this.uriComponentsBuilder
.cloneBuilder()
.path(RestCall.this.path)
.queryParams(this.queryParams)
.toUriString();
}
public HttpEntity<?> buildRequestEntity() {
if (this.streamingBody != null) {
return new HttpEntity<>(new InputStreamResource(this.streamingBody), this.httpHeaders);
} else if (this.body != null) {
return new HttpEntity<>(this.body, this.httpHeaders);
} else {
return new HttpEntity<>(this.httpHeaders);
}
}
public Map<String, String> getURIVariables() {
return Utils.immutableMapOf(this.uriVariables);
}
@Override
public String toString() {
return "RestCallBuilder [httpHeaders=" + this.httpHeaders + ", body=" + this.body + ", queryParams="
+ this.queryParams
+ ", uriVariables=" + this.uriVariables + "]";
}
}
public static final class TypeKey<T> {
final CallType callType;
final EntityType entityType;
private final TypeReference<T> typeRef;
public TypeKey(
final CallType callType,
final EntityType entityType,
final TypeReference<T> typeRef) {
this.callType = callType;
this.entityType = entityType;
this.typeRef = typeRef;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((this.callType == null) ? 0 : this.callType.hashCode());
result = prime * result + ((this.entityType == null) ? 0 : this.entityType.hashCode());
return result;
}
@Override
public boolean equals(final Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
final TypeKey<?> other = (TypeKey<?>) obj;
if (this.callType != other.callType)
return false;
if (this.entityType != other.entityType)
return false;
return true;
}
}
}

120
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/api/RestCallError.java
View file

@ -1,61 +1,59 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.api.APIMessageError;
import ch.ethz.seb.sebserver.gbl.util.Utils;
public class RestCallError extends RuntimeException implements APIMessageError {
private static final long serialVersionUID = -5201349295667957490L;
final List<APIMessage> errors;
public RestCallError(final String message, final Throwable cause) {
super(message, cause);
this.errors = new ArrayList<>();
}
public RestCallError(final String message, final Collection<APIMessage> apiErrors) {
super(message);
this.errors = Utils.immutableListOf(apiErrors);
}
public RestCallError(final String message) {
super(message);
this.errors = new ArrayList<>();
}
@Override
public List<APIMessage> getErrorMessages() {
return this.errors;
}
public boolean hasErrorMessages() {
return !this.errors.isEmpty();
}
public boolean isFieldValidationError() {
return this.errors
.stream()
.filter(error -> APIMessage.ErrorMessage.FIELD_VALIDATION.isOf(error))
.findFirst()
.isPresent();
}
@Override
public String toString() {
return "RestCallError [errors=" + this.errors + "]";
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.api.APIMessageError;
import ch.ethz.seb.sebserver.gbl.util.Utils;
public class RestCallError extends RuntimeException implements APIMessageError {
private static final long serialVersionUID = -5201349295667957490L;
final List<APIMessage> errors;
public RestCallError(final String message, final Throwable cause) {
super(message, cause);
this.errors = new ArrayList<>();
}
public RestCallError(final String message, final Collection<APIMessage> apiErrors) {
super(message);
this.errors = Utils.immutableListOf(apiErrors);
}
public RestCallError(final String message) {
super(message);
this.errors = new ArrayList<>();
}
@Override
public List<APIMessage> getErrorMessages() {
return this.errors;
}
public boolean hasErrorMessages() {
return !this.errors.isEmpty();
}
public boolean isFieldValidationError() {
return this.errors
.stream()
.anyMatch(APIMessage.ErrorMessage.FIELD_VALIDATION::isOf);
}
@Override
public String toString() {
return "RestCallError [errors=" + this.errors + "]";
}
}

146
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/api/RestService.java
View file

@ -1,74 +1,74 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponentsBuilder;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestCall.CallType;
/** Interface to SEB Server webservice API thought RestCall's
* or thought Spring's RestTemplate on lower level.
*
* A RestCall's can be used to call a specified SEB Server webservice API endpoint with given request parameter.
* This service collects all the available RestCalls and map them by Class type or EntityType and CallType.
*
* For Example if one want to get a certain User-Account by API request on SEB Server webservice API:
*
* <pre>
* UserInfo userInfo = RestService.getBuilder(GetUserAccount.class)
* .withURIVariable(API.PARAM_MODEL_ID, user-account-id) adds an URI path variable
* .withQueryParam(API.PARAM_INSTITUTION_ID, institutionId) adds a URI query parameter
* .call() executes the API request call
* .get(pageContext::notifyError) gets the result or notify an error to the user if happened
* </pre>
*/
public interface RestService {
/** Get Spring's RestTemplate that is used within this service.
*
* @return Spring's RestTemplate that is used within this service. */
RestTemplate getWebserviceAPIRestTemplate();
/** Get Spring's UriComponentsBuilder that is used within this service.
*
* @return Spring's UriComponentsBuilder that is used within this service. */
UriComponentsBuilder getWebserviceURIBuilder();
/** Get a certain RestCall by Class type.
*
* @param type the Class type of the RestCall
* @return RestCall instance */
<T> RestCall<T> getRestCall(Class<? extends RestCall<T>> type);
/** Get a certain RestCall by EntityType and CallType.
* NOTE not all RestCall can be get within this method. Only the ones that have a defined CallType
*
* @param entityType The EntityType of the RestCall
* @param callType The CallType of the RestCall (not UNDEFINDED)
* @return RestCall instance */
<T> RestCall<T> getRestCall(EntityType entityType, CallType callType);
/** Get a certain RestCallBuilder by RestCall Class type.
*
* @param type the Class type of the RestCall
* @return RestCallBuilder instance to build a dedicated call and execute it */
<T> RestCall<T>.RestCallBuilder getBuilder(Class<? extends RestCall<T>> type);
/** Get a certain RestCallBuilder by EntityType and CallType.
*
* @param entityType The EntityType of the RestCall to get a builder for
* @param callType The CallType of the RestCall to get a builder for (not UNDEFINDED)
* @return RestCallBuilder instance to build a dedicated call and execute it */
<T> RestCall<T>.RestCallBuilder getBuilder(
EntityType entityType,
CallType callType);
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponentsBuilder;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestCall.CallType;
/** Interface to SEB Server webservice API thought RestCall's
* or thought Spring's RestTemplate on lower level.
*
* A RestCall's can be used to call a specified SEB Server webservice API endpoint with given request parameter.
* This service collects all the available RestCalls and map them by Class type or EntityType and CallType.
*
* For Example if one want to get a certain User-Account by API request on SEB Server webservice API:
*
* <pre>
* UserInfo userInfo = RestService.getBuilder(GetUserAccount.class)
* .withURIVariable(API.PARAM_MODEL_ID, user-account-id) adds an URI path variable
* .withQueryParam(API.PARAM_INSTITUTION_ID, institutionId) adds a URI query parameter
* .call() executes the API request call
* .get(pageContext::notifyError) gets the result or notify an error to the user if happened
* </pre>
*/
public interface RestService {
/** Get Spring's RestTemplate that is used within this service.
*
* @return Spring's RestTemplate that is used within this service. */
RestTemplate getWebserviceAPIRestTemplate();
/** Get Spring's UriComponentsBuilder that is used within this service.
*
* @return Spring's UriComponentsBuilder that is used within this service. */
UriComponentsBuilder getWebserviceURIBuilder();
/** Get a certain RestCall by Class type.
*
* @param type the Class type of the RestCall
* @return RestCall instance */
<T> RestCall<T> getRestCall(Class<? extends RestCall<T>> type);
/** Get a certain RestCall by EntityType and CallType.
* NOTE not all RestCall can be get within this method. Only the ones that have a defined CallType
*
* @param entityType The EntityType of the RestCall
* @param callType The CallType of the RestCall (not UNDEFINED)
* @return RestCall instance */
<T> RestCall<T> getRestCall(EntityType entityType, CallType callType);
/** Get a certain RestCallBuilder by RestCall Class type.
*
* @param type the Class type of the RestCall
* @return RestCallBuilder instance to build a dedicated call and execute it */
<T> RestCall<T>.RestCallBuilder getBuilder(Class<? extends RestCall<T>> type);
/** Get a certain RestCallBuilder by EntityType and CallType.
*
* @param entityType The EntityType of the RestCall to get a builder for
* @param callType The CallType of the RestCall to get a builder for (not UNDEFINED)
* @return RestCallBuilder instance to build a dedicated call and execute it */
<T> RestCall<T>.RestCallBuilder getBuilder(
EntityType entityType,
CallType callType);
}

81
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/api/useraccount/SaveUserAccount.java
View file

@ -1,40 +1,41 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api.useraccount;
import org.springframework.context.annotation.Lazy;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import com.fasterxml.jackson.core.type.TypeReference;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.model.user.UserInfo;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestCall;
@Lazy
@Component
@GuiProfile
public class SaveUserAccount extends RestCall<UserInfo> {
public SaveUserAccount() {
super(new TypeKey<>(
CallType.SAVE,
EntityType.USER,
new TypeReference<UserInfo>() {
}),
HttpMethod.PUT,
MediaType.APPLICATION_JSON_UTF8,
API.USER_ACCOUNT_ENDPOINT);
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.api.useraccount;
import org.springframework.context.annotation.Lazy;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import com.fasterxml.jackson.core.type.TypeReference;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.model.user.UserInfo;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestCall;
@Lazy
@Component
@GuiProfile
public class SaveUserAccount extends RestCall<UserInfo> {
public SaveUserAccount() {
super(new TypeKey<>(
CallType.SAVE,
EntityType.USER,
new TypeReference<UserInfo>() {
}),
HttpMethod.PUT,
MediaType.APPLICATION_JSON_UTF8,
API.USER_ACCOUNT_ENDPOINT);
}
}

692
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/auth/CurrentUser.java
View file

@ -1,348 +1,344 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.context.WebApplicationContext;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.api.authorization.Privilege;
import ch.ethz.seb.sebserver.gbl.api.authorization.Privilege.RoleTypeKey;
import ch.ethz.seb.sebserver.gbl.api.authorization.PrivilegeType;
import ch.ethz.seb.sebserver.gbl.model.GrantEntity;
import ch.ethz.seb.sebserver.gbl.model.user.UserInfo;
import ch.ethz.seb.sebserver.gbl.model.user.UserRole;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
@Component
@GuiProfile
@Scope(value = WebApplicationContext.SCOPE_SESSION, proxyMode = ScopedProxyMode.TARGET_CLASS)
public class CurrentUser {
private static final Logger log = LoggerFactory.getLogger(CurrentUser.class);
private final AuthorizationContextHolder authorizationContextHolder;
private SEBServerAuthorizationContext authContext = null;
private Map<RoleTypeKey, Privilege> privileges = null;
private final Map<String, String> attributes;
public CurrentUser(final AuthorizationContextHolder authorizationContextHolder) {
this.authorizationContextHolder = authorizationContextHolder;
this.attributes = new HashMap<>();
}
public void putAttribute(final String name, final String value) {
this.attributes.put(name, value);
}
public String getAttribute(final String name) {
return this.attributes.get(name);
}
public AuthorizationContextHolder getAuthorizationContextHolder() {
return this.authorizationContextHolder;
}
public UserInfo get() {
if (isAvailable()) {
return this.authContext
.getLoggedInUser()
.getOrThrow();
}
return handleIllegalSessionState();
}
public UserInfo getOrHandleError(final Function<Exception, UserInfo> errorHandler) {
if (isAvailable()) {
return this.authContext
.getLoggedInUser()
.get(errorHandler);
}
return handleIllegalSessionState();
}
private UserInfo handleIllegalSessionState() {
log.warn("Current user requested but no user is currently logged in");
this.logout();
throw new IllegalUserSessionStateException("User not logged in");
}
public GrantCheck grantCheck(final EntityType entityType) {
return new GrantCheck(entityType);
}
public EntityGrantCheck entityGrantCheck(final GrantEntity grantEntity) {
return new EntityGrantCheck(grantEntity);
}
public boolean hasBasePrivilege(final PrivilegeType privilegeType, final EntityType entityType) {
return hasPrivilege(privilegeType, entityType, null, null);
}
public boolean hasInstitutionalPrivilege(final PrivilegeType privilegeType, final EntityType entityType) {
final UserInfo userInfo = get();
return hasPrivilege(privilegeType, entityType, userInfo.institutionId, null);
}
public boolean hasPrivilege(
final PrivilegeType privilegeType,
final EntityType entityType,
final Long institutionId,
final String ownerId) {
if (loadPrivileges()) {
try {
final UserInfo userInfo = get();
return userInfo
.getRoles()
.stream()
.map(roleName -> UserRole.valueOf(roleName))
.map(role -> new RoleTypeKey(entityType, role))
.map(key -> this.privileges.get(key))
.filter(priv -> (priv != null) && priv.hasGrant(
userInfo.uuid,
userInfo.institutionId,
privilegeType,
institutionId,
ownerId))
.findFirst()
.isPresent();
} catch (final Exception e) {
log.error("Failed to verify privilege: PrivilegeType {} EntityType {}",
privilegeType, entityType, e);
}
}
return false;
}
public boolean hasPrivilege(
final PrivilegeType privilegeType,
final GrantEntity grantEntity) {
if (loadPrivileges()) {
final EntityType entityType = grantEntity.entityType();
try {
final UserInfo userInfo = get();
return userInfo.getRoles()
.stream()
.map(roleName -> UserRole.valueOf(roleName))
.map(role -> new RoleTypeKey(entityType, role))
.map(key -> this.privileges.get(key))
.filter(priv -> (priv != null) && priv.hasGrant(
userInfo.uuid,
userInfo.institutionId,
privilegeType,
grantEntity.getInstitutionId(),
grantEntity.getOwnerId()))
.findFirst()
.isPresent();
} catch (final Exception e) {
log.error("Failed to verify privilege: PrivilegeType {} EntityType {}",
privilegeType, entityType, e);
}
}
return false;
}
public boolean isAvailable() {
updateContext();
return this.authContext != null && this.authContext.isLoggedIn();
}
public void refresh(final UserInfo userInfo) {
this.authContext.refreshUser(userInfo);
}
public boolean logout() {
if (this.attributes != null) {
this.attributes.clear();
}
this.privileges = null;
if (isAvailable()) {
if (this.authContext.logout()) {
this.authContext = null;
return true;
} else {
return false;
}
} else {
try {
return this.authorizationContextHolder
.getAuthorizationContext()
.logout();
} catch (final Exception e) {
log.warn("Unexpected error while logout: {}", e.getMessage());
return false;
}
}
}
private void updateContext() {
if (this.authContext == null || !this.authContext.isValid()) {
this.authContext = this.authorizationContextHolder.getAuthorizationContext();
}
}
private boolean loadPrivileges() {
if (this.privileges != null) {
return true;
}
updateContext();
if (this.authContext != null) {
try {
final WebserviceURIService webserviceURIService =
this.authorizationContextHolder.getWebserviceURIService();
final ResponseEntity<Collection<Privilege>> exchange = this.authContext.getRestTemplate()
.exchange(
webserviceURIService.getURIBuilder()
.path(API.PRIVILEGES_ENDPOINT)
.toUriString(),
HttpMethod.GET,
HttpEntity.EMPTY,
Constants.TYPE_REFERENCE_PRIVILEGES);
if (exchange.getStatusCodeValue() == HttpStatus.OK.value()) {
final Collection<Privilege> privileges = exchange.getBody();
if (privileges != null) {
this.privileges = privileges
.stream()
.reduce(new HashMap<RoleTypeKey, Privilege>(),
(map, priv) -> {
map.put(priv.roleTypeKey, priv);
return map;
},
(map1, map2) -> {
map1.putAll(map2);
return map1;
});
} else {
log.error("Failed to get Privileges from webservice API: {}", exchange);
return false;
}
return true;
} else {
log.error("Failed to get Privileges from webservice API: {}", exchange);
return false;
}
} catch (final Exception e) {
log.error("Failed to get Privileges from webservice API: ", e);
return false;
}
} else {
log.error("Failed to get Privileges from webservice API. No AuthorizationContext available");
return false;
}
}
/** Wrapper can be used for base and institutional grant checks for a specified EntityType */
public class GrantCheck {
private final EntityType entityType;
protected GrantCheck(final EntityType entityType) {
this.entityType = entityType;
}
/** Checks the base read-only privilege grant
*
* @return true on read-only privilege grant on wrapped EntityType */
public boolean r() {
return hasBasePrivilege(PrivilegeType.READ, this.entityType);
}
/** Checks the base modify privilege grant
*
* @return true on modify privilege grant on wrapped EntityType */
public boolean m() {
return hasBasePrivilege(PrivilegeType.MODIFY, this.entityType);
}
/** Checks the base write privilege grant
*
* @return true on write privilege grant on wrapped EntityType */
public boolean w() {
return hasBasePrivilege(PrivilegeType.WRITE, this.entityType);
}
/** Checks the institutional read-only privilege grant
*
* @return true institutional read-only privilege grant on wrapped EntityType */
public boolean ir() {
return hasInstitutionalPrivilege(PrivilegeType.READ, this.entityType);
}
/** Checks the institutional modify privilege grant
*
* @return true institutional modify privilege grant on wrapped EntityType */
public boolean im() {
return hasInstitutionalPrivilege(PrivilegeType.MODIFY, this.entityType);
}
/** Checks the institutional write privilege grant
*
* @return true institutional write privilege grant on wrapped EntityType */
public boolean iw() {
return hasInstitutionalPrivilege(PrivilegeType.WRITE, this.entityType);
}
}
/** Wrapper can be used for Entity based grant checks */
public class EntityGrantCheck {
private final GrantEntity grantEntity;
protected EntityGrantCheck(final GrantEntity grantEntity) {
this.grantEntity = grantEntity;
}
/** Checks the read-only privilege grant for wrapped grantEntity
*
* @return true on read-only privilege grant for wrapped grantEntity */
public boolean r() {
return hasPrivilege(PrivilegeType.READ, this.grantEntity);
}
/** Checks the modify privilege grant for wrapped grantEntity
*
* @return true on modify privilege grant for wrapped grantEntity */
public boolean m() {
return hasPrivilege(PrivilegeType.MODIFY, this.grantEntity);
}
/** Checks the write privilege grant for wrapped grantEntity
*
* @return true on write privilege grant for wrapped grantEntity */
public boolean w() {
return hasPrivilege(PrivilegeType.WRITE, this.grantEntity);
}
}
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.context.WebApplicationContext;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.api.authorization.Privilege;
import ch.ethz.seb.sebserver.gbl.api.authorization.Privilege.RoleTypeKey;
import ch.ethz.seb.sebserver.gbl.api.authorization.PrivilegeType;
import ch.ethz.seb.sebserver.gbl.model.GrantEntity;
import ch.ethz.seb.sebserver.gbl.model.user.UserInfo;
import ch.ethz.seb.sebserver.gbl.model.user.UserRole;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
@Component
@GuiProfile
@Scope(value = WebApplicationContext.SCOPE_SESSION, proxyMode = ScopedProxyMode.TARGET_CLASS)
public class CurrentUser {
private static final Logger log = LoggerFactory.getLogger(CurrentUser.class);
private final AuthorizationContextHolder authorizationContextHolder;
private SEBServerAuthorizationContext authContext = null;
private Map<RoleTypeKey, Privilege> privileges = null;
private final Map<String, String> attributes;
public CurrentUser(final AuthorizationContextHolder authorizationContextHolder) {
this.authorizationContextHolder = authorizationContextHolder;
this.attributes = new HashMap<>();
}
public void putAttribute(final String name, final String value) {
this.attributes.put(name, value);
}
public String getAttribute(final String name) {
return this.attributes.get(name);
}
public AuthorizationContextHolder getAuthorizationContextHolder() {
return this.authorizationContextHolder;
}
public UserInfo get() {
if (isAvailable()) {
return this.authContext
.getLoggedInUser()
.getOrThrow();
}
return handleIllegalSessionState();
}
public UserInfo getOrHandleError(final Function<Exception, UserInfo> errorHandler) {
if (isAvailable()) {
return this.authContext
.getLoggedInUser()
.get(errorHandler);
}
return handleIllegalSessionState();
}
private UserInfo handleIllegalSessionState() {
log.warn("Current user requested but no user is currently logged in");
this.logout();
throw new IllegalUserSessionStateException("User not logged in");
}
public GrantCheck grantCheck(final EntityType entityType) {
return new GrantCheck(entityType);
}
public EntityGrantCheck entityGrantCheck(final GrantEntity grantEntity) {
return new EntityGrantCheck(grantEntity);
}
public boolean hasBasePrivilege(final PrivilegeType privilegeType, final EntityType entityType) {
return hasPrivilege(privilegeType, entityType, null, null);
}
public boolean hasInstitutionalPrivilege(final PrivilegeType privilegeType, final EntityType entityType) {
final UserInfo userInfo = get();
return hasPrivilege(privilegeType, entityType, userInfo.institutionId, null);
}
public boolean hasPrivilege(
final PrivilegeType privilegeType,
final EntityType entityType,
final Long institutionId,
final String ownerId) {
if (loadPrivileges()) {
try {
final UserInfo userInfo = get();
return userInfo
.getRoles()
.stream()
.map(UserRole::valueOf)
.map(role -> new RoleTypeKey(entityType, role))
.map(key -> this.privileges.get(key))
.anyMatch(privilege -> (privilege != null) && privilege.hasGrant(
userInfo.uuid,
userInfo.institutionId,
privilegeType,
institutionId,
ownerId));
} catch (final Exception e) {
log.error("Failed to verify privilege: PrivilegeType {} EntityType {}",
privilegeType, entityType, e);
}
}
return false;
}
public boolean hasPrivilege(
final PrivilegeType privilegeType,
final GrantEntity grantEntity) {
if (loadPrivileges()) {
final EntityType entityType = grantEntity.entityType();
try {
final UserInfo userInfo = get();
return userInfo.getRoles()
.stream()
.map(UserRole::valueOf)
.map(role -> new RoleTypeKey(entityType, role))
.map(key -> this.privileges.get(key))
.anyMatch(privilege -> (privilege != null) && privilege.hasGrant(
userInfo.uuid,
userInfo.institutionId,
privilegeType,
grantEntity.getInstitutionId(),
grantEntity.getOwnerId()));
} catch (final Exception e) {
log.error("Failed to verify privilege: PrivilegeType {} EntityType {}",
privilegeType, entityType, e);
}
}
return false;
}
public boolean isAvailable() {
updateContext();
return this.authContext != null && this.authContext.isLoggedIn();
}
public void refresh(final UserInfo userInfo) {
this.authContext.refreshUser(userInfo);
}
public boolean logout() {
if (this.attributes != null) {
this.attributes.clear();
}
this.privileges = null;
if (isAvailable()) {
if (this.authContext.logout()) {
this.authContext = null;
return true;
} else {
return false;
}
} else {
try {
return this.authorizationContextHolder
.getAuthorizationContext()
.logout();
} catch (final Exception e) {
log.warn("Unexpected error while logout: {}", e.getMessage());
return false;
}
}
}
private void updateContext() {
if (this.authContext == null || !this.authContext.isValid()) {
this.authContext = this.authorizationContextHolder.getAuthorizationContext();
}
}
private boolean loadPrivileges() {
if (this.privileges != null) {
return true;
}
updateContext();
if (this.authContext != null) {
try {
final WebserviceURIService webserviceURIService =
this.authorizationContextHolder.getWebserviceURIService();
final ResponseEntity<Collection<Privilege>> exchange = this.authContext.getRestTemplate()
.exchange(
webserviceURIService.getURIBuilder()
.path(API.PRIVILEGES_ENDPOINT)
.toUriString(),
HttpMethod.GET,
HttpEntity.EMPTY,
Constants.TYPE_REFERENCE_PRIVILEGES);
if (exchange.getStatusCodeValue() == HttpStatus.OK.value()) {
final Collection<Privilege> privileges = exchange.getBody();
if (privileges != null) {
this.privileges = privileges
.stream()
.reduce(new HashMap<>(),
(map, privilege) -> {
map.put(privilege.roleTypeKey, privilege);
return map;
},
(map1, map2) -> {
map1.putAll(map2);
return map1;
});
} else {
log.error("Failed to get Privileges from webservice API: {}", exchange);
return false;
}
return true;
} else {
log.error("Failed to get Privileges from webservice API: {}", exchange);
return false;
}
} catch (final Exception e) {
log.error("Failed to get Privileges from webservice API: ", e);
return false;
}
} else {
log.error("Failed to get Privileges from webservice API. No AuthorizationContext available");
return false;
}
}
/** Wrapper can be used for base and institutional grant checks for a specified EntityType */
public class GrantCheck {
private final EntityType entityType;
protected GrantCheck(final EntityType entityType) {
this.entityType = entityType;
}
/** Checks the base read-only privilege grant
*
* @return true on read-only privilege grant on wrapped EntityType */
public boolean r() {
return hasBasePrivilege(PrivilegeType.READ, this.entityType);
}
/** Checks the base modify privilege grant
*
* @return true on modify privilege grant on wrapped EntityType */
public boolean m() {
return hasBasePrivilege(PrivilegeType.MODIFY, this.entityType);
}
/** Checks the base write privilege grant
*
* @return true on write privilege grant on wrapped EntityType */
public boolean w() {
return hasBasePrivilege(PrivilegeType.WRITE, this.entityType);
}
/** Checks the institutional read-only privilege grant
*
* @return true institutional read-only privilege grant on wrapped EntityType */
public boolean ir() {
return hasInstitutionalPrivilege(PrivilegeType.READ, this.entityType);
}
/** Checks the institutional modify privilege grant
*
* @return true institutional modify privilege grant on wrapped EntityType */
public boolean im() {
return hasInstitutionalPrivilege(PrivilegeType.MODIFY, this.entityType);
}
/** Checks the institutional write privilege grant
*
* @return true institutional write privilege grant on wrapped EntityType */
public boolean iw() {
return hasInstitutionalPrivilege(PrivilegeType.WRITE, this.entityType);
}
}
/** Wrapper can be used for Entity based grant checks */
public class EntityGrantCheck {
private final GrantEntity grantEntity;
protected EntityGrantCheck(final GrantEntity grantEntity) {
this.grantEntity = grantEntity;
}
/** Checks the read-only privilege grant for wrapped grantEntity
*
* @return true on read-only privilege grant for wrapped grantEntity */
public boolean r() {
return hasPrivilege(PrivilegeType.READ, this.grantEntity);
}
/** Checks the modify privilege grant for wrapped grantEntity
*
* @return true on modify privilege grant for wrapped grantEntity */
public boolean m() {
return hasPrivilege(PrivilegeType.MODIFY, this.grantEntity);
}
/** Checks the write privilege grant for wrapped grantEntity
*
* @return true on write privilege grant for wrapped grantEntity */
public boolean w() {
return hasPrivilege(PrivilegeType.WRITE, this.grantEntity);
}
}
}

664
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/auth/OAuth2AuthorizationContextHolder.java
View file

@ -1,333 +1,331 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import java.io.IOException;
import java.net.URI;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import javax.servlet.http.HttpSession;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Lazy;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.security.access.AccessDeniedException;
import org.springframework.security.oauth2.client.DefaultOAuth2ClientContext;
import org.springframework.security.oauth2.client.OAuth2RestTemplate;
import org.springframework.security.oauth2.client.http.OAuth2ErrorHandler;
import org.springframework.security.oauth2.client.resource.OAuth2AccessDeniedException;
import org.springframework.security.oauth2.client.resource.OAuth2ProtectedResourceDetails;
import org.springframework.security.oauth2.client.token.DefaultAccessTokenRequest;
import org.springframework.security.oauth2.client.token.grant.password.ResourceOwnerPasswordResourceDetails;
import org.springframework.security.oauth2.common.OAuth2AccessToken;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RequestCallback;
import org.springframework.web.client.ResponseExtractor;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestTemplate;
import ch.ethz.seb.sebserver.ClientHttpRequestFactoryService;
import ch.ethz.seb.sebserver.gbl.model.user.UserInfo;
import ch.ethz.seb.sebserver.gbl.model.user.UserRole;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gbl.util.Result;
import ch.ethz.seb.sebserver.gbl.util.Utils;
@Lazy
@Component
@GuiProfile
public class OAuth2AuthorizationContextHolder implements AuthorizationContextHolder {
private static final Logger log = LoggerFactory.getLogger(OAuth2AuthorizationContextHolder.class);
private static final String CONTEXT_HOLDER_ATTRIBUTE = "CONTEXT_HOLDER_ATTRIBUTE";
private final String guiClientId;
private final String guiClientSecret;
private final WebserviceURIService webserviceURIService;
private final ClientHttpRequestFactoryService clientHttpRequestFactoryService;
@Autowired
public OAuth2AuthorizationContextHolder(
@Value("${sebserver.webservice.api.admin.clientId}") final String guiClientId,
@Value("${sebserver.webservice.api.admin.clientSecret}") final String guiClientSecret,
final WebserviceURIService webserviceURIService,
final ClientHttpRequestFactoryService clientHttpRequestFactoryService) {
this.guiClientId = guiClientId;
this.guiClientSecret = guiClientSecret;
this.webserviceURIService = webserviceURIService;
this.clientHttpRequestFactoryService = clientHttpRequestFactoryService;
}
@Override
public WebserviceURIService getWebserviceURIService() {
return this.webserviceURIService;
}
@Override
public SEBServerAuthorizationContext getAuthorizationContext(final HttpSession session) {
log.debug("Trying to get OAuth2AuthorizationContext from HttpSession: {}", session.getId());
OAuth2AuthorizationContext context =
(OAuth2AuthorizationContext) session.getAttribute(CONTEXT_HOLDER_ATTRIBUTE);
if (context == null || !context.valid) {
log.debug(
"OAuth2AuthorizationContext for HttpSession: {} is not present or is invalid. "
+ "Create new OAuth2AuthorizationContext for this session",
session.getId());
final ClientHttpRequestFactory clientHttpRequestFactory = this.clientHttpRequestFactoryService
.getClientHttpRequestFactory()
.getOrThrow();
context = new OAuth2AuthorizationContext(
this.guiClientId,
this.guiClientSecret,
this.webserviceURIService,
clientHttpRequestFactory);
session.setAttribute(CONTEXT_HOLDER_ATTRIBUTE, context);
}
return context;
}
private static final class DisposableOAuth2RestTemplate extends OAuth2RestTemplate {
private boolean enabled = true;
public DisposableOAuth2RestTemplate(final OAuth2ProtectedResourceDetails resource) {
super(
resource,
new DefaultOAuth2ClientContext(new DefaultAccessTokenRequest()));
}
@Override
protected <T> T doExecute(
final URI url,
final HttpMethod method,
final RequestCallback requestCallback,
final ResponseExtractor<T> responseExtractor) throws RestClientException {
if (this.enabled) {
return super.doExecute(url, method, requestCallback, responseExtractor);
} else {
throw new IllegalStateException(
"Error: Forbidden execution call on disabled DisposableOAuth2RestTemplate");
}
}
}
private static final class OAuth2AuthorizationContext implements SEBServerAuthorizationContext {
private static final String GRANT_TYPE = "password";
private static final List<String> SCOPES = Collections.unmodifiableList(
Arrays.asList("read", "write"));
private boolean valid = true;
private final ResourceOwnerPasswordResourceDetails resource;
private final DisposableOAuth2RestTemplate restTemplate;
private final String revokeTokenURI;
private final String currentUserURI;
private Result<UserInfo> loggedInUser = null;
OAuth2AuthorizationContext(
final String guiClientId,
final String guiClientSecret,
final WebserviceURIService webserviceURIService,
final ClientHttpRequestFactory clientHttpRequestFactory) {
this.resource = new ResourceOwnerPasswordResourceDetails();
this.resource.setAccessTokenUri(webserviceURIService.getOAuthTokenURI());
this.resource.setClientId(guiClientId);
this.resource.setClientSecret(guiClientSecret);
this.resource.setGrantType(GRANT_TYPE);
this.resource.setScope(SCOPES);
this.restTemplate = new DisposableOAuth2RestTemplate(this.resource);
this.restTemplate.setRequestFactory(clientHttpRequestFactory);
this.restTemplate.setErrorHandler(new ErrorHandler(this.resource));
this.restTemplate
.getMessageConverters()
.add(0, new StringHttpMessageConverter(Charset.forName("UTF-8")));
this.revokeTokenURI = webserviceURIService.getOAuthRevokeTokenURI();
this.currentUserURI = webserviceURIService.getCurrentUserRequestURI();
}
@Override
public boolean isValid() {
return this.valid;
}
@Override
public boolean isLoggedIn() {
final OAuth2AccessToken accessToken = this.restTemplate.getOAuth2ClientContext().getAccessToken();
if (accessToken == null || StringUtils.isEmpty(accessToken.toString())) {
return false;
}
try {
final ResponseEntity<String> forEntity =
this.restTemplate.getForEntity(this.currentUserURI, String.class);
if (forEntity.getStatusCode() != HttpStatus.OK) {
return false;
}
} catch (final Exception e) {
log.error("Failed to verify logged in user: {}", e.getMessage());
return false;
}
return true;
}
@Override
public boolean login(final String username, final CharSequence password) {
if (!this.valid || this.isLoggedIn()) {
return false;
}
this.resource.setUsername(username);
this.resource.setPassword(Utils.toString(password));
log.debug("Trying to login for user: {}", username);
try {
this.restTemplate.getAccessToken();
log.debug("Got token for user: {}", username);
this.loggedInUser = getLoggedInUser();
return true;
} catch (final OAuth2AccessDeniedException | AccessDeniedException e) {
log.info("Access Denied for user: {}", username);
return false;
}
}
@Override
public boolean logout() {
// set this context invalid to force creation of a new context on next request
this.valid = false;
this.loggedInUser = null;
if (this.restTemplate.getAccessToken() != null) {
// delete the access-token (and refresh-token) on authentication server side
this.restTemplate.delete(this.revokeTokenURI);
// delete the access-token within the RestTemplate
this.restTemplate.getOAuth2ClientContext().setAccessToken(null);
}
// mark the RestTemplate as disposed
this.restTemplate.enabled = false;
return true;
}
@Override
public RestTemplate getRestTemplate() {
return this.restTemplate;
}
@Override
public void refreshUser(final UserInfo userInfo) {
// delete the access-token (and refresh-token) on authentication server side
this.restTemplate.delete(this.revokeTokenURI);
// delete the access-token within the RestTemplate
this.restTemplate.getOAuth2ClientContext().setAccessToken(null);
// check if username has changed
if (!userInfo.username.equals(getLoggedInUser().get().username)) {
// Set new username to be able to request new access token
this.resource.setUsername(userInfo.username);
}
// and request new access token
this.restTemplate.getAccessToken();
// and reset logged in user by getting actual one from webservice
this.loggedInUser = null;
getLoggedInUser()
.getOrThrow();
}
@Override
public Result<UserInfo> getLoggedInUser() {
if (this.loggedInUser != null) {
return this.loggedInUser;
}
log.debug("Request logged in User from SEBserver web-service API");
try {
if (isValid() && isLoggedIn()) {
final ResponseEntity<UserInfo> response =
this.restTemplate
.getForEntity(this.currentUserURI, UserInfo.class);
if (response.getStatusCode() == HttpStatus.OK) {
this.loggedInUser = Result.of(response.getBody());
return this.loggedInUser;
} else {
log.error("Unexpected error response: {}", response);
return Result.ofError(new IllegalStateException(
"Http Request responded with status: " + response.getStatusCode()));
}
} else {
return Result.ofError(
new IllegalStateException("Logged in User requested on invalid or not logged in "));
}
} catch (final AccessDeniedException | OAuth2AccessDeniedException ade) {
log.error("Acccess denied while trying to request logged in User from API", ade);
return Result.ofError(ade);
} catch (final Exception e) {
log.error("Unexpected error while trying to request logged in User from API", e);
return Result.ofError(
new RuntimeException("Unexpected error while trying to request logged in User from API", e));
}
}
@Override
public boolean hasRole(final UserRole role) {
if (!isValid() || !isLoggedIn()) {
return false;
}
return getLoggedInUser()
.getOrThrow().roles
.contains(role.name());
}
private static final class ErrorHandler extends OAuth2ErrorHandler {
private ErrorHandler(final OAuth2ProtectedResourceDetails resource) {
super(resource);
}
@Override
public boolean hasError(final ClientHttpResponse response) throws IOException {
try {
final HttpStatus statusCode = HttpStatus.resolve(response.getRawStatusCode());
return (statusCode != null && statusCode.series().equals(HttpStatus.Series.SERVER_ERROR));
} catch (final Exception e) {
log.error("Unexpected: ", e);
return super.hasError(response);
}
}
}
}
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import ch.ethz.seb.sebserver.ClientHttpRequestFactoryService;
import ch.ethz.seb.sebserver.gbl.model.user.UserInfo;
import ch.ethz.seb.sebserver.gbl.model.user.UserRole;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gbl.util.Result;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Lazy;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.security.access.AccessDeniedException;
import org.springframework.security.oauth2.client.DefaultOAuth2ClientContext;
import org.springframework.security.oauth2.client.OAuth2RestTemplate;
import org.springframework.security.oauth2.client.http.OAuth2ErrorHandler;
import org.springframework.security.oauth2.client.resource.OAuth2AccessDeniedException;
import org.springframework.security.oauth2.client.resource.OAuth2ProtectedResourceDetails;
import org.springframework.security.oauth2.client.token.DefaultAccessTokenRequest;
import org.springframework.security.oauth2.client.token.grant.password.ResourceOwnerPasswordResourceDetails;
import org.springframework.security.oauth2.common.OAuth2AccessToken;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RequestCallback;
import org.springframework.web.client.ResponseExtractor;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestTemplate;
import javax.servlet.http.HttpSession;
import java.io.IOException;
import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
@Lazy
@Component
@GuiProfile
public class OAuth2AuthorizationContextHolder implements AuthorizationContextHolder {
private static final Logger log = LoggerFactory.getLogger(OAuth2AuthorizationContextHolder.class);
private static final String CONTEXT_HOLDER_ATTRIBUTE = "CONTEXT_HOLDER_ATTRIBUTE";
private final String guiClientId;
private final String guiClientSecret;
private final WebserviceURIService webserviceURIService;
private final ClientHttpRequestFactoryService clientHttpRequestFactoryService;
@Autowired
public OAuth2AuthorizationContextHolder(
@Value("${sebserver.webservice.api.admin.clientId}") final String guiClientId,
@Value("${sebserver.webservice.api.admin.clientSecret}") final String guiClientSecret,
final WebserviceURIService webserviceURIService,
final ClientHttpRequestFactoryService clientHttpRequestFactoryService) {
this.guiClientId = guiClientId;
this.guiClientSecret = guiClientSecret;
this.webserviceURIService = webserviceURIService;
this.clientHttpRequestFactoryService = clientHttpRequestFactoryService;
}
@Override
public WebserviceURIService getWebserviceURIService() {
return this.webserviceURIService;
}
@Override
public SEBServerAuthorizationContext getAuthorizationContext(final HttpSession session) {
log.debug("Trying to get OAuth2AuthorizationContext from HttpSession: {}", session.getId());
OAuth2AuthorizationContext context =
(OAuth2AuthorizationContext) session.getAttribute(CONTEXT_HOLDER_ATTRIBUTE);
if (context == null || !context.valid) {
log.debug(
"OAuth2AuthorizationContext for HttpSession: {} is not present or is invalid. "
+ "Create new OAuth2AuthorizationContext for this session",
session.getId());
final ClientHttpRequestFactory clientHttpRequestFactory = this.clientHttpRequestFactoryService
.getClientHttpRequestFactory()
.getOrThrow();
context = new OAuth2AuthorizationContext(
this.guiClientId,
this.guiClientSecret,
this.webserviceURIService,
clientHttpRequestFactory);
session.setAttribute(CONTEXT_HOLDER_ATTRIBUTE, context);
}
return context;
}
private static final class DisposableOAuth2RestTemplate extends OAuth2RestTemplate {
private boolean enabled = true;
public DisposableOAuth2RestTemplate(final OAuth2ProtectedResourceDetails resource) {
super(
resource,
new DefaultOAuth2ClientContext(new DefaultAccessTokenRequest()));
}
@Override
protected <T> T doExecute(
final URI url,
final HttpMethod method,
final RequestCallback requestCallback,
final ResponseExtractor<T> responseExtractor) throws RestClientException {
if (this.enabled) {
return super.doExecute(url, method, requestCallback, responseExtractor);
} else {
throw new IllegalStateException(
"Error: Forbidden execution call on disabled DisposableOAuth2RestTemplate");
}
}
}
private static final class OAuth2AuthorizationContext implements SEBServerAuthorizationContext {
private static final String GRANT_TYPE = "password";
private static final List<String> SCOPES = Collections.unmodifiableList(
Arrays.asList("read", "write"));
private boolean valid = true;
private final ResourceOwnerPasswordResourceDetails resource;
private final DisposableOAuth2RestTemplate restTemplate;
private final String revokeTokenURI;
private final String currentUserURI;
private Result<UserInfo> loggedInUser = null;
OAuth2AuthorizationContext(
final String guiClientId,
final String guiClientSecret,
final WebserviceURIService webserviceURIService,
final ClientHttpRequestFactory clientHttpRequestFactory) {
this.resource = new ResourceOwnerPasswordResourceDetails();
this.resource.setAccessTokenUri(webserviceURIService.getOAuthTokenURI());
this.resource.setClientId(guiClientId);
this.resource.setClientSecret(guiClientSecret);
this.resource.setGrantType(GRANT_TYPE);
this.resource.setScope(SCOPES);
this.restTemplate = new DisposableOAuth2RestTemplate(this.resource);
this.restTemplate.setRequestFactory(clientHttpRequestFactory);
this.restTemplate.setErrorHandler(new ErrorHandler(this.resource));
this.restTemplate
.getMessageConverters()
.add(0, new StringHttpMessageConverter(StandardCharsets.UTF_8));
this.revokeTokenURI = webserviceURIService.getOAuthRevokeTokenURI();
this.currentUserURI = webserviceURIService.getCurrentUserRequestURI();
}
@Override
public boolean isValid() {
return this.valid;
}
@Override
public boolean isLoggedIn() {
final OAuth2AccessToken accessToken = this.restTemplate.getOAuth2ClientContext().getAccessToken();
if (accessToken == null || StringUtils.isEmpty(accessToken.toString())) {
return false;
}
try {
final ResponseEntity<String> forEntity =
this.restTemplate.getForEntity(this.currentUserURI, String.class);
if (forEntity.getStatusCode() != HttpStatus.OK) {
return false;
}
} catch (final Exception e) {
log.error("Failed to verify logged in user: {}", e.getMessage());
return false;
}
return true;
}
@Override
public boolean login(final String username, final CharSequence password) {
if (!this.valid || this.isLoggedIn()) {
return false;
}
this.resource.setUsername(username);
this.resource.setPassword(Utils.toString(password));
log.debug("Trying to login for user: {}", username);
try {
this.restTemplate.getAccessToken();
log.debug("Got token for user: {}", username);
this.loggedInUser = getLoggedInUser();
return true;
} catch (final OAuth2AccessDeniedException | AccessDeniedException e) {
log.info("Access Denied for user: {}", username);
return false;
}
}
@Override
public boolean logout() {
// set this context invalid to force creation of a new context on next request
this.valid = false;
this.loggedInUser = null;
if (this.restTemplate.getAccessToken() != null) {
// delete the access-token (and refresh-token) on authentication server side
this.restTemplate.delete(this.revokeTokenURI);
// delete the access-token within the RestTemplate
this.restTemplate.getOAuth2ClientContext().setAccessToken(null);
}
// mark the RestTemplate as disposed
this.restTemplate.enabled = false;
return true;
}
@Override
public RestTemplate getRestTemplate() {
return this.restTemplate;
}
@Override
public void refreshUser(final UserInfo userInfo) {
// delete the access-token (and refresh-token) on authentication server side
this.restTemplate.delete(this.revokeTokenURI);
// delete the access-token within the RestTemplate
this.restTemplate.getOAuth2ClientContext().setAccessToken(null);
// check if username has changed
if (!userInfo.username.equals(getLoggedInUser().get().username)) {
// Set new username to be able to request new access token
this.resource.setUsername(userInfo.username);
}
// and request new access token
this.restTemplate.getAccessToken();
// and reset logged in user by getting actual one from webservice
this.loggedInUser = null;
getLoggedInUser()
.getOrThrow();
}
@Override
public Result<UserInfo> getLoggedInUser() {
if (this.loggedInUser != null) {
return this.loggedInUser;
}
log.debug("Request logged in User from SEBserver web-service API");
try {
if (isValid() && isLoggedIn()) {
final ResponseEntity<UserInfo> response =
this.restTemplate
.getForEntity(this.currentUserURI, UserInfo.class);
if (response.getStatusCode() == HttpStatus.OK) {
this.loggedInUser = Result.of(response.getBody());
return this.loggedInUser;
} else {
log.error("Unexpected error response: {}", response);
return Result.ofError(new IllegalStateException(
"Http Request responded with status: " + response.getStatusCode()));
}
} else {
return Result.ofError(
new IllegalStateException("Logged in User requested on invalid or not logged in "));
}
} catch (final AccessDeniedException | OAuth2AccessDeniedException ade) {
log.error("Acccess denied while trying to request logged in User from API", ade);
return Result.ofError(ade);
} catch (final Exception e) {
log.error("Unexpected error while trying to request logged in User from API", e);
return Result.ofError(
new RuntimeException("Unexpected error while trying to request logged in User from API", e));
}
}
@Override
public boolean hasRole(final UserRole role) {
if (!isValid() || !isLoggedIn()) {
return false;
}
return getLoggedInUser()
.getOrThrow().roles
.contains(role.name());
}
private static final class ErrorHandler extends OAuth2ErrorHandler {
private ErrorHandler(final OAuth2ProtectedResourceDetails resource) {
super(resource);
}
@Override
public boolean hasError(final ClientHttpResponse response) throws IOException {
try {
final HttpStatus statusCode = HttpStatus.resolve(response.getRawStatusCode());
return (statusCode != null && statusCode.series().equals(HttpStatus.Series.SERVER_ERROR));
} catch (final Exception e) {
log.error("Unexpected: ", e);
return super.hasError(response);
}
}
}
}
}

132
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/auth/SEBServerAuthorizationContext.java
View file

@ -1,66 +1,66 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import org.springframework.web.client.RestTemplate;
import ch.ethz.seb.sebserver.gbl.model.user.UserInfo;
import ch.ethz.seb.sebserver.gbl.model.user.UserRole;
import ch.ethz.seb.sebserver.gbl.util.Result;
/** Defines functionality for the SEB Server webservice authorization context used to
* manage a user session on GUI service. */
public interface SEBServerAuthorizationContext {
/** Indicates if this authorization context is still valid
*
* @return true if the SEBServerAuthorizationContext is valid. False of not. */
boolean isValid();
/** Indicated whether a user is logged in within this authorization context or not.
*
* @return whether a user is logged in within this authorization context or not */
boolean isLoggedIn();
/** Requests a login with username and password on SEB Server webservice.
* This uses OAuth 2 and Springs OAuth2RestTemplate to exchange user/client credentials
* with an access and refresh token.
*
* @param username the username for login
* @param password the password for login
* @return */
boolean login(String username, CharSequence password);
/** Requests a logout on SEB Server webservice if a user is currently logged in
* This uses OAuth 2 and Springs OAuth2RestTemplate to make a revoke token request for the
* currently logged in user and also invalidates this SEBServerAuthorizationContext
*
* @return true if logout was successful */
boolean logout();
/** Gets a Result of the UserInfo data of currently logged in user or of an error if no user is logged in
* or there was an unexpected error while trying to get the user information.
*
* @return Result of logged in user data or of an error on fail */
Result<UserInfo> getLoggedInUser();
void refreshUser(UserInfo userInfo);
/** Returns true if a current logged in user has the specified role.
*
* @param role the UserRole to check
* @return true if a current logged in user has the specified role */
boolean hasRole(UserRole role);
/** Get the underling RestTemplate to connect and communicate with the SEB Server webservice.
*
* @return the underling RestTemplate to connect and communicate with the SEB Server webservice */
RestTemplate getRestTemplate();
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import org.springframework.web.client.RestTemplate;
import ch.ethz.seb.sebserver.gbl.model.user.UserInfo;
import ch.ethz.seb.sebserver.gbl.model.user.UserRole;
import ch.ethz.seb.sebserver.gbl.util.Result;
/** Defines functionality for the SEB Server webservice authorization context used to
* manage a user session on GUI service. */
public interface SEBServerAuthorizationContext {
/** Indicates if this authorization context is still valid
*
* @return true if the SEBServerAuthorizationContext is valid. False of not. */
boolean isValid();
/** Indicated whether a user is logged in within this authorization context or not.
*
* @return whether a user is logged in within this authorization context or not */
boolean isLoggedIn();
/** Requests a login with username and password on SEB Server webservice.
* This uses OAuth 2 and Springs OAuth2RestTemplate to exchange user/client credentials
* with an access and refresh token.
*
* @param username the username for login
* @param password the password for login
* @return true if login was successful, false if no */
boolean login(String username, CharSequence password);
/** Requests a logout on SEB Server webservice if a user is currently logged in
* This uses OAuth 2 and Springs OAuth2RestTemplate to make a revoke token request for the
* currently logged in user and also invalidates this SEBServerAuthorizationContext
*
* @return true if logout was successful */
boolean logout();
/** Gets a Result of the UserInfo data of currently logged in user or of an error if no user is logged in
* or there was an unexpected error while trying to get the user information.
*
* @return Result of logged in user data or of an error on fail */
Result<UserInfo> getLoggedInUser();
void refreshUser(UserInfo userInfo);
/** Returns true if a current logged in user has the specified role.
*
* @param role the UserRole to check
* @return true if a current logged in user has the specified role */
boolean hasRole(UserRole role);
/** Get the underling RestTemplate to connect and communicate with the SEB Server webservice.
*
* @return the underling RestTemplate to connect and communicate with the SEB Server webservice */
RestTemplate getRestTemplate();
}

228
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/auth/WebserviceConnectionData.java
View file

@ -1,114 +1,114 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import org.springframework.web.util.UriComponentsBuilder;
public class WebserviceConnectionData {
final String id;
final String webserviceProtocol;
final String webserviceServerAdress;
final String webserviceServerPort;
final String webserviceAPIPath;
final String webserviceServerAddress;
private final UriComponentsBuilder webserviceURIBuilder;
protected WebserviceConnectionData(
final String id,
final String webserviceProtocol,
final String webserviceServerAdress,
final String webserviceServerPort,
final String webserviceAPIPath) {
this.id = id;
this.webserviceProtocol = webserviceProtocol;
this.webserviceServerAdress = webserviceServerAdress;
this.webserviceServerPort = webserviceServerPort;
this.webserviceAPIPath = webserviceAPIPath;
this.webserviceServerAddress = webserviceProtocol + "://" + webserviceServerAdress + ":" + webserviceServerPort;
this.webserviceURIBuilder = UriComponentsBuilder
.fromHttpUrl(webserviceProtocol + "://" + webserviceServerAdress)
.port(webserviceServerPort)
.path(webserviceAPIPath);
}
public String getId() {
return this.id;
}
public String getWebserviceProtocol() {
return this.webserviceProtocol;
}
public String getWebserviceServerAdress() {
return this.webserviceServerAdress;
}
public String getWebserviceServerPort() {
return this.webserviceServerPort;
}
public String getWebserviceAPIPath() {
return this.webserviceAPIPath;
}
public String getWebserviceServerAddress() {
return this.webserviceServerAddress;
}
public UriComponentsBuilder getWebserviceURIBuilder() {
return this.webserviceURIBuilder.cloneBuilder();
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((this.id == null) ? 0 : this.id.hashCode());
return result;
}
@Override
public boolean equals(final Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
final WebserviceConnectionData other = (WebserviceConnectionData) obj;
if (this.id == null) {
if (other.id != null)
return false;
} else if (!this.id.equals(other.id))
return false;
return true;
}
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
builder.append("WebserviceConnectionData [id=");
builder.append(this.id);
builder.append(", webserviceProtocol=");
builder.append(this.webserviceProtocol);
builder.append(", webserviceServerAdress=");
builder.append(this.webserviceServerAdress);
builder.append(", webserviceServerPort=");
builder.append(this.webserviceServerPort);
builder.append(", webserviceAPIPath=");
builder.append(this.webserviceAPIPath);
builder.append("]");
return builder.toString();
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import org.springframework.web.util.UriComponentsBuilder;
public class WebserviceConnectionData {
final String id;
final String webserviceProtocol;
final String webserviceServerAddress;
final String webserviceServerPort;
final String webserviceAPIPath;
final String webserviceServerURL;
private final UriComponentsBuilder webserviceURIBuilder;
protected WebserviceConnectionData(
final String id,
final String webserviceProtocol,
final String webserviceServerAddress,
final String webserviceServerPort,
final String webserviceAPIPath) {
this.id = id;
this.webserviceProtocol = webserviceProtocol;
this.webserviceServerAddress = webserviceServerAddress;
this.webserviceServerPort = webserviceServerPort;
this.webserviceAPIPath = webserviceAPIPath;
this.webserviceServerURL = webserviceProtocol + "://" + webserviceServerAddress + ":" + webserviceServerPort;
this.webserviceURIBuilder = UriComponentsBuilder
.fromHttpUrl(webserviceProtocol + "://" + webserviceServerAddress)
.port(webserviceServerPort)
.path(webserviceAPIPath);
}
public String getId() {
return this.id;
}
public String getWebserviceProtocol() {
return this.webserviceProtocol;
}
public String getWebserviceServerAddress() {
return this.webserviceServerAddress;
}
public String getWebserviceServerPort() {
return this.webserviceServerPort;
}
public String getWebserviceAPIPath() {
return this.webserviceAPIPath;
}
public String getWebserviceServerURL() {
return this.webserviceServerURL;
}
public UriComponentsBuilder getWebserviceURIBuilder() {
return this.webserviceURIBuilder.cloneBuilder();
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((this.id == null) ? 0 : this.id.hashCode());
return result;
}
@Override
public boolean equals(final Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
final WebserviceConnectionData other = (WebserviceConnectionData) obj;
if (this.id == null) {
if (other.id != null)
return false;
} else if (!this.id.equals(other.id))
return false;
return true;
}
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
builder.append("WebserviceConnectionData [id=");
builder.append(this.id);
builder.append(", webserviceProtocol=");
builder.append(this.webserviceProtocol);
builder.append(", webserviceServerAddress=");
builder.append(this.webserviceServerAddress);
builder.append(", webserviceServerPort=");
builder.append(this.webserviceServerPort);
builder.append(", webserviceAPIPath=");
builder.append(this.webserviceAPIPath);
builder.append("]");
return builder.toString();
}
}

138
src/main/java/ch/ethz/seb/sebserver/gui/service/remote/webservice/auth/WebserviceURIService.java
View file

@ -1,69 +1,69 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.util.UriComponentsBuilder;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
@Component
@GuiProfile
public class WebserviceURIService {
private final String servletContextPath;
private final String webserviceServerAddress;
private final UriComponentsBuilder webserviceURIBuilder;
public WebserviceURIService(
@Value("${sebserver.gui.webservice.protocol}") final String webserviceProtocol,
@Value("${sebserver.gui.webservice.address}") final String webserviceServerAdress,
@Value("${sebserver.gui.webservice.port}") final String webserviceServerPort,
@Value("${server.servlet.context-path}") final String servletContextPath,
@Value("${sebserver.gui.webservice.apipath}") final String webserviceAPIPath) {
this.servletContextPath = servletContextPath;
this.webserviceServerAddress = webserviceProtocol + "://" + webserviceServerAdress + ":" + webserviceServerPort;
this.webserviceURIBuilder = UriComponentsBuilder
.fromHttpUrl(webserviceProtocol + "://" + webserviceServerAdress)
.port(webserviceServerPort)
.path(servletContextPath)
.path(webserviceAPIPath);
}
public String getWebserviceServerAddress() {
return this.webserviceServerAddress;
}
public UriComponentsBuilder getURIBuilder() {
return this.webserviceURIBuilder.cloneBuilder();
}
public String getOAuthTokenURI() {
return UriComponentsBuilder.fromHttpUrl(this.webserviceServerAddress)
.path(this.servletContextPath)
.path(API.OAUTH_TOKEN_ENDPOINT)
.toUriString();
}
public String getOAuthRevokeTokenURI() {
return UriComponentsBuilder.fromHttpUrl(this.webserviceServerAddress)
.path(this.servletContextPath)
.path(API.OAUTH_REVOKE_TOKEN_ENDPOINT)
.toUriString();
}
public String getCurrentUserRequestURI() {
return getURIBuilder()
.path(API.CURRENT_USER_ENDPOINT)
.toUriString();
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.remote.webservice.auth;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.util.UriComponentsBuilder;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
@Component
@GuiProfile
public class WebserviceURIService {
private final String servletContextPath;
private final String webserviceServerAddress;
private final UriComponentsBuilder webserviceURIBuilder;
public WebserviceURIService(
@Value("${sebserver.gui.webservice.protocol}") final String webserviceProtocol,
@Value("${sebserver.gui.webservice.address}") final String webserviceServerAddress,
@Value("${sebserver.gui.webservice.port}") final String webserviceServerPort,
@Value("${server.servlet.context-path}") final String servletContextPath,
@Value("${sebserver.gui.webservice.apipath}") final String webserviceAPIPath) {
this.servletContextPath = servletContextPath;
this.webserviceServerAddress = webserviceProtocol + "://" + webserviceServerAddress + ":" + webserviceServerPort;
this.webserviceURIBuilder = UriComponentsBuilder
.fromHttpUrl(webserviceProtocol + "://" + webserviceServerAddress)
.port(webserviceServerPort)
.path(servletContextPath)
.path(webserviceAPIPath);
}
public String getWebserviceServerAddress() {
return this.webserviceServerAddress;
}
public UriComponentsBuilder getURIBuilder() {
return this.webserviceURIBuilder.cloneBuilder();
}
public String getOAuthTokenURI() {
return UriComponentsBuilder.fromHttpUrl(this.webserviceServerAddress)
.path(this.servletContextPath)
.path(API.OAUTH_TOKEN_ENDPOINT)
.toUriString();
}
public String getOAuthRevokeTokenURI() {
return UriComponentsBuilder.fromHttpUrl(this.webserviceServerAddress)
.path(this.servletContextPath)
.path(API.OAUTH_REVOKE_TOKEN_ENDPOINT)
.toUriString();
}
public String getCurrentUserRequestURI() {
return getURIBuilder()
.path(API.CURRENT_USER_ENDPOINT)
.toUriString();
}
}

14
src/main/java/ch/ethz/seb/sebserver/gui/service/session/ClientConnectionDetails.java
View file

@ -49,12 +49,10 @@ public class ClientConnectionDetails {
private static final int NUMBER_OF_NONE_INDICATOR_ROWS = 3;
private final PageService pageService;
private final ResourceService resourceService;
private final Exam exam;
private final EnumMap<IndicatorType, IndicatorData> indicatorMapping;
private final RestCall<ClientConnectionData>.RestCallBuilder restCallBuilder;
private final FormHandle<?> formhandle;
private final FormHandle<?> formHandle;
private final ColorData colorData;
private ClientConnectionData connectionData = null;
@ -69,9 +67,7 @@ public class ClientConnectionDetails {
final Display display = pageContext.getRoot().getDisplay();
this.pageService = pageService;
this.resourceService = pageService.getResourceService();
this.exam = exam;
this.restCallBuilder = restCallBuilder;
this.colorData = new ColorData(display);
this.indicatorMapping = IndicatorData.createFormIndicators(
@ -80,12 +76,12 @@ public class ClientConnectionDetails {
this.colorData,
NUMBER_OF_NONE_INDICATOR_ROWS);
final FormBuilder formBuilder = this.pageService.formBuilder(pageContext)
final FormBuilder formBuilder = pageService.formBuilder(pageContext)
.readonly(true)
.addField(FormBuilder.text(
QuizData.QUIZ_ATTR_NAME,
EXAM_NAME_TEXT_KEY,
this.exam.getName()))
exam.getName()))
.addField(FormBuilder.text(
Domain.CLIENT_CONNECTION.ATTR_EXAM_USER_SESSION_ID,
CONNECTION_ID_TEXT_KEY,
@ -112,7 +108,7 @@ public class ClientConnectionDetails {
.withDefaultLabel(indData.indicator.name))
.addEmptyCell());
this.formhandle = formBuilder.build();
this.formHandle = formBuilder.build();
}
public void updateData() {
@ -136,7 +132,7 @@ public class ClientConnectionDetails {
return;
}
final Form form = this.formhandle.getForm();
final Form form = this.formHandle.getForm();
form.setFieldValue(
Domain.CLIENT_CONNECTION.ATTR_EXAM_USER_SESSION_ID,
this.connectionData.clientConnection.userSessionId);

16
src/main/java/ch/ethz/seb/sebserver/gui/service/session/ClientConnectionTable.java
View file

@ -371,7 +371,7 @@ public final class ClientConnectionTable {
private void sortTable() {
this.tableMapping = this.tableMapping.entrySet()
.stream()
.sorted((e1, e2) -> e1.getValue().compareTo(e2.getValue()))
.sorted(Entry.comparingByValue())
.collect(Collectors.toMap(
Entry::getKey,
Entry::getValue,
@ -398,13 +398,12 @@ public final class ClientConnectionTable {
final String attribute = this.resourceService
.getCurrentUser()
.getAttribute(USER_SESSION_STATUS_FILTER_ATTRIBUTE);
this.statusFilter.clear();
if (attribute != null) {
this.statusFilter.clear();
Arrays.asList(StringUtils.split(attribute, Constants.LIST_SEPARATOR))
.forEach(name -> this.statusFilter.add(ConnectionStatus.valueOf(name)));
} else {
this.statusFilter.clear();
this.statusFilter.add(ConnectionStatus.DISABLED);
}
} catch (final Exception e) {
@ -460,7 +459,7 @@ public final class ClientConnectionTable {
}
void updateData(final TableItem tableItem) {
tableItem.setText(0, getConnectionIdentifer());
tableItem.setText(0, getConnectionIdentifier());
tableItem.setText(1, getConnectionAddress());
tableItem.setText(2, getStatusName());
}
@ -533,7 +532,7 @@ public final class ClientConnectionTable {
public int compareTo(final UpdatableTableItem other) {
return Comparator.comparingInt(UpdatableTableItem::statusWeight)
.thenComparingInt(UpdatableTableItem::thresholdsWeight)
.thenComparing(UpdatableTableItem::getConnectionIdentifer)
.thenComparing(UpdatableTableItem::getConnectionIdentifier)
.compare(this, other);
}
@ -580,7 +579,7 @@ public final class ClientConnectionTable {
return Constants.EMPTY_NOTE;
}
String getConnectionIdentifer() {
String getConnectionIdentifier() {
if (this.connectionData != null && this.connectionData.clientConnection.userSessionId != null) {
return this.connectionData.clientConnection.userSessionId;
}
@ -608,10 +607,7 @@ public final class ClientConnectionTable {
final IndicatorData indicatorData =
ClientConnectionTable.this.indicatorMapping.get(indicatorValue.getType());
if (indicatorData == null) {
log.error("No IndicatorData of type: {} found", indicatorValue.getType());
} else {
if (indicatorData != null) {
final double value = indicatorValue.getValue();
final int indicatorWeight = IndicatorData.getWeight(indicatorData, value);
if (this.indicatorWeights[indicatorData.index] != indicatorWeight) {

197
src/main/java/ch/ethz/seb/sebserver/gui/service/session/IndicatorData.java
View file

@ -1,100 +1,99 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.session;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumMap;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.widgets.Display;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator.IndicatorType;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator.Threshold;
import ch.ethz.seb.sebserver.gbl.util.Utils;
final class IndicatorData {
final int index;
final int tableIndex;
final Indicator indicator;
final Color defaultColor;
final Color defaultTextColor;
final ThresholdColor[] thresholdColor;
protected IndicatorData(
final Indicator indicator,
final int index,
final int tableIndex,
final ColorData colorData,
final Display display) {
this.indicator = indicator;
this.index = index;
this.tableIndex = tableIndex;
this.defaultColor = new Color(display, Utils.toRGB(indicator.defaultColor), 255);
this.defaultTextColor = Utils.darkColor(this.defaultColor.getRGB())
? colorData.darkColor
: colorData.lightColor;
this.thresholdColor = new ThresholdColor[indicator.thresholds.size()];
final ArrayList<Threshold> sortedThresholds = new ArrayList<>(indicator.thresholds);
Collections.sort(sortedThresholds, (t1, t2) -> t1.value.compareTo(t2.value));
for (int i = 0; i < indicator.thresholds.size(); i++) {
this.thresholdColor[i] = new ThresholdColor(sortedThresholds.get(i), display, colorData);
}
}
static final EnumMap<IndicatorType, IndicatorData> createFormIndicators(
final Collection<Indicator> indicators,
final Display display,
final ColorData colorData,
final int tableIndexOffset) {
final EnumMap<IndicatorType, IndicatorData> indicatorMapping = new EnumMap<>(IndicatorType.class);
int i = 0;
for (final Indicator indicator : indicators) {
indicatorMapping.put(indicator.type, new IndicatorData(
indicator,
i,
i + tableIndexOffset,
colorData,
display));
i++;
}
return indicatorMapping;
}
static final int getWeight(final IndicatorData indicatorData, final double value) {
for (int j = 0; j < indicatorData.thresholdColor.length; j++) {
if (value < indicatorData.thresholdColor[j].value) {
return (j == 0) ? -1 : j - 1;
}
}
return indicatorData.thresholdColor.length - 1;
}
static final class ThresholdColor {
final double value;
final Color color;
final Color textColor;
protected ThresholdColor(final Threshold threshold, final Display display, final ColorData colorData) {
this.value = threshold.value;
this.color = new Color(display, Utils.toRGB(threshold.color), 255);
this.textColor = Utils.darkColor(this.color.getRGB())
? colorData.darkColor
: colorData.lightColor;
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.session;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator.IndicatorType;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator.Threshold;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.widgets.Display;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.EnumMap;
final class IndicatorData {
final int index;
final int tableIndex;
final Indicator indicator;
final Color defaultColor;
final Color defaultTextColor;
final ThresholdColor[] thresholdColor;
protected IndicatorData(
final Indicator indicator,
final int index,
final int tableIndex,
final ColorData colorData,
final Display display) {
this.indicator = indicator;
this.index = index;
this.tableIndex = tableIndex;
this.defaultColor = new Color(display, Utils.toRGB(indicator.defaultColor), 255);
this.defaultTextColor = Utils.darkColor(this.defaultColor.getRGB())
? colorData.darkColor
: colorData.lightColor;
this.thresholdColor = new ThresholdColor[indicator.thresholds.size()];
final ArrayList<Threshold> sortedThresholds = new ArrayList<>(indicator.thresholds);
sortedThresholds.sort(Comparator.comparing(t -> t.value));
for (int i = 0; i < indicator.thresholds.size(); i++) {
this.thresholdColor[i] = new ThresholdColor(sortedThresholds.get(i), display, colorData);
}
}
static EnumMap<IndicatorType, IndicatorData> createFormIndicators(
final Collection<Indicator> indicators,
final Display display,
final ColorData colorData,
final int tableIndexOffset) {
final EnumMap<IndicatorType, IndicatorData> indicatorMapping = new EnumMap<>(IndicatorType.class);
int i = 0;
for (final Indicator indicator : indicators) {
indicatorMapping.put(indicator.type, new IndicatorData(
indicator,
i,
i + tableIndexOffset,
colorData,
display));
i++;
}
return indicatorMapping;
}
static int getWeight(final IndicatorData indicatorData, final double value) {
for (int j = 0; j < indicatorData.thresholdColor.length; j++) {
if (value < indicatorData.thresholdColor[j].value) {
return (j == 0) ? -1 : j - 1;
}
}
return indicatorData.thresholdColor.length - 1;
}
static final class ThresholdColor {
final double value;
final Color color;
final Color textColor;
protected ThresholdColor(final Threshold threshold, final Display display, final ColorData colorData) {
this.value = threshold.value;
this.color = new Color(display, Utils.toRGB(threshold.color), 255);
this.textColor = Utils.darkColor(this.color.getRGB())
? colorData.darkColor
: colorData.lightColor;
}
}
}

325
src/main/java/ch/ethz/seb/sebserver/gui/service/session/InstructionProcessor.java
View file

@ -1,165 +1,160 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.session;
import java.util.Collection;
import java.util.Set;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Service;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.api.JSONMapper;
import ch.ethz.seb.sebserver.gbl.model.Domain;
import ch.ethz.seb.sebserver.gbl.model.session.ClientConnection;
import ch.ethz.seb.sebserver.gbl.model.session.ClientConnection.ConnectionStatus;
import ch.ethz.seb.sebserver.gbl.model.session.ClientInstruction;
import ch.ethz.seb.sebserver.gbl.model.session.ClientInstruction.InstructionType;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestCallError;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.session.DisableClientConnection;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.session.PropagateInstruction;
@Lazy
@Service
@GuiProfile
public class InstructionProcessor {
private static final Logger log = LoggerFactory.getLogger(InstructionProcessor.class);
private final RestService restService;
private final JSONMapper jsonMapper;
protected InstructionProcessor(final PageService pageService) {
this.restService = pageService.getRestService();
this.jsonMapper = pageService.getJSONMapper();
}
public void propagateSebQuitInstruction(
final Long examId,
final String connectionToken,
final PageContext pageContext) {
propagateSebQuitInstruction(
examId,
p -> Stream.of(connectionToken).collect(Collectors.toSet()),
pageContext);
}
public void propagateSebQuitInstruction(
final Long examId,
final Function<Predicate<ClientConnection>, Set<String>> selectionFunction,
final PageContext pageContext) {
final Set<String> connectionTokens = selectionFunction
.apply(ClientConnection.getStatusPredicate(ConnectionStatus.ACTIVE));
if (connectionTokens.isEmpty()) {
// TODO message
return;
}
if (log.isDebugEnabled()) {
log.debug("Propagate SEB quit instruction for exam: {} and connections: {}",
examId,
connectionTokens);
}
final ClientInstruction clientInstruction = new ClientInstruction(
null,
examId,
InstructionType.SEB_QUIT,
StringUtils.join(connectionTokens, Constants.LIST_SEPARATOR),
null);
processInstruction(() -> {
return this.restService.getBuilder(PropagateInstruction.class)
.withURIVariable(API.PARAM_MODEL_ID, String.valueOf(examId))
.withBody(clientInstruction)
.call()
.getOrThrow();
},
pageContext);
}
public void disableConnection(
final Long examId,
final Function<Predicate<ClientConnection>, Set<String>> selectionFunction,
final PageContext pageContext) {
final Set<String> connectionTokens = selectionFunction
.apply(ClientConnection.getStatusPredicate(
ConnectionStatus.CONNECTION_REQUESTED,
ConnectionStatus.UNDEFINED,
ConnectionStatus.CLOSED,
ConnectionStatus.AUTHENTICATED));
if (connectionTokens.isEmpty()) {
// TOOD message
return;
}
if (log.isDebugEnabled()) {
log.debug("Disable SEB client connections for exam: {} and connections: {}",
examId,
connectionTokens);
}
processInstruction(() -> {
return this.restService.getBuilder(DisableClientConnection.class)
.withURIVariable(API.PARAM_MODEL_ID, String.valueOf(examId))
.withFormParam(
Domain.CLIENT_CONNECTION.ATTR_CONNECTION_TOKEN,
StringUtils.join(connectionTokens, Constants.LIST_SEPARATOR))
.call()
.getOrThrow();
},
pageContext);
}
private void processInstruction(final Supplier<String> apiCall, final PageContext pageContext) {
try {
final String response = apiCall.get();
if (StringUtils.isNotBlank(response)) {
try {
final Collection<APIMessage> errorMessage = this.jsonMapper.readValue(
response,
Constants.TYPE_REFERENCE_API_MESSAGE);
pageContext.notifyUnexpectedError(new RestCallError(
"Failed to propagate SEB client instruction: ",
errorMessage));
} catch (final Exception e) {
log.error("Failed to parse error response: {}", response);
}
}
} catch (final Exception e) {
log.error("Failed to propagate SEB client instruction: ", e);
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.service.session;
import java.util.Collection;
import java.util.Set;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Service;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.api.APIMessage;
import ch.ethz.seb.sebserver.gbl.api.JSONMapper;
import ch.ethz.seb.sebserver.gbl.model.Domain;
import ch.ethz.seb.sebserver.gbl.model.session.ClientConnection;
import ch.ethz.seb.sebserver.gbl.model.session.ClientConnection.ConnectionStatus;
import ch.ethz.seb.sebserver.gbl.model.session.ClientInstruction;
import ch.ethz.seb.sebserver.gbl.model.session.ClientInstruction.InstructionType;
import ch.ethz.seb.sebserver.gbl.profile.GuiProfile;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestCallError;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestService;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.session.DisableClientConnection;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.session.PropagateInstruction;
@Lazy
@Service
@GuiProfile
public class InstructionProcessor {
private static final Logger log = LoggerFactory.getLogger(InstructionProcessor.class);
private final RestService restService;
private final JSONMapper jsonMapper;
protected InstructionProcessor(final PageService pageService) {
this.restService = pageService.getRestService();
this.jsonMapper = pageService.getJSONMapper();
}
public void propagateSebQuitInstruction(
final Long examId,
final String connectionToken,
final PageContext pageContext) {
propagateSebQuitInstruction(
examId,
p -> Stream.of(connectionToken).collect(Collectors.toSet()),
pageContext);
}
public void propagateSebQuitInstruction(
final Long examId,
final Function<Predicate<ClientConnection>, Set<String>> selectionFunction,
final PageContext pageContext) {
final Set<String> connectionTokens = selectionFunction
.apply(ClientConnection.getStatusPredicate(ConnectionStatus.ACTIVE));
if (connectionTokens.isEmpty()) {
// TODO message
return;
}
if (log.isDebugEnabled()) {
log.debug("Propagate SEB quit instruction for exam: {} and connections: {}",
examId,
connectionTokens);
}
final ClientInstruction clientInstruction = new ClientInstruction(
null,
examId,
InstructionType.SEB_QUIT,
StringUtils.join(connectionTokens, Constants.LIST_SEPARATOR),
null);
processInstruction(() -> this.restService.getBuilder(PropagateInstruction.class)
.withURIVariable(API.PARAM_MODEL_ID, String.valueOf(examId))
.withBody(clientInstruction)
.call()
.getOrThrow(),
pageContext);
}
public void disableConnection(
final Long examId,
final Function<Predicate<ClientConnection>, Set<String>> selectionFunction,
final PageContext pageContext) {
final Set<String> connectionTokens = selectionFunction
.apply(ClientConnection.getStatusPredicate(
ConnectionStatus.CONNECTION_REQUESTED,
ConnectionStatus.UNDEFINED,
ConnectionStatus.CLOSED,
ConnectionStatus.AUTHENTICATED));
if (connectionTokens.isEmpty()) {
return;
}
if (log.isDebugEnabled()) {
log.debug("Disable SEB client connections for exam: {} and connections: {}",
examId,
connectionTokens);
}
processInstruction(() -> this.restService.getBuilder(DisableClientConnection.class)
.withURIVariable(API.PARAM_MODEL_ID, String.valueOf(examId))
.withFormParam(
Domain.CLIENT_CONNECTION.ATTR_CONNECTION_TOKEN,
StringUtils.join(connectionTokens, Constants.LIST_SEPARATOR))
.call()
.getOrThrow(),
pageContext);
}
private void processInstruction(final Supplier<String> apiCall, final PageContext pageContext) {
try {
final String response = apiCall.get();
if (StringUtils.isNotBlank(response)) {
try {
final Collection<APIMessage> errorMessage = this.jsonMapper.readValue(
response,
Constants.TYPE_REFERENCE_API_MESSAGE);
pageContext.notifyUnexpectedError(new RestCallError(
"Failed to propagate SEB client instruction: ",
errorMessage));
} catch (final Exception e) {
log.error("Failed to parse error response: {}", response);
}
}
} catch (final Exception e) {
log.error("Failed to propagate SEB client instruction: ", e);
}
}
}

1494
src/main/java/ch/ethz/seb/sebserver/gui/table/EntityTable.java
View file

File diff suppressed because it is too large Load diff

348
src/main/java/ch/ethz/seb/sebserver/gui/table/TableBuilder.java
View file

@ -1,174 +1,174 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.table;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.BooleanSupplier;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.TableItem;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import ch.ethz.seb.sebserver.gbl.model.Entity;
import ch.ethz.seb.sebserver.gbl.model.Page;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.service.page.impl.PageAction;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestCall;
public class TableBuilder<ROW extends Entity> {
private final String name;
private final PageService pageService;
final RestCall<Page<ROW>> restCall;
private final MultiValueMap<String, String> staticQueryParams;
final List<ColumnDefinition<ROW>> columns = new ArrayList<>();
LocTextKey emptyMessage;
private Function<EntityTable<ROW>, PageAction> defaultActionFunction;
private int pageSize = -1;
private int type = SWT.NONE;
private boolean hideNavigation = false;
private Function<RestCall<Page<ROW>>.RestCallBuilder, RestCall<Page<ROW>>.RestCallBuilder> restCallAdapter;
private BiConsumer<TableItem, ROW> rowDecorator;
private Consumer<Set<ROW>> selectionListener;
private boolean markupEnabled = false;
public TableBuilder(
final String name,
final PageService pageService,
final RestCall<Page<ROW>> restCall) {
this.name = name;
this.pageService = pageService;
this.restCall = restCall;
this.staticQueryParams = new LinkedMultiValueMap<>();
}
public TableBuilder<ROW> hideNavigation() {
this.hideNavigation = true;
return this;
}
public TableBuilder<ROW> withEmptyMessage(final LocTextKey emptyMessage) {
this.emptyMessage = emptyMessage;
return this;
}
public TableBuilder<ROW> withPaging(final int pageSize) {
this.pageSize = pageSize;
return this;
}
public TableBuilder<ROW> withColumn(final ColumnDefinition<ROW> columnDefinition) {
this.columns.add(columnDefinition);
return this;
}
public TableBuilder<ROW> withMarkup() {
this.markupEnabled = true;
return this;
}
public TableBuilder<ROW> withColumnIf(
final BooleanSupplier condition,
final Supplier<ColumnDefinition<ROW>> columnDefSupplier) {
if (condition != null && condition.getAsBoolean()) {
this.columns.add(columnDefSupplier.get());
}
return this;
}
public TableBuilder<ROW> withRestCallAdapter(
final Function<RestCall<Page<ROW>>.RestCallBuilder, RestCall<Page<ROW>>.RestCallBuilder> adapter) {
this.restCallAdapter = adapter;
return this;
}
public TableBuilder<ROW> withMultiselection() {
this.type |= SWT.MULTI;
return this;
}
public TableBuilder<ROW> withSelectionListener(final Consumer<Set<ROW>> selectionListener) {
this.selectionListener = selectionListener;
return this;
}
public TableBuilder<ROW> withStaticFilter(final String name, final String value) {
this.staticQueryParams.add(name, value);
return this;
}
public TableBuilder<ROW> withDefaultActionIf(
final BooleanSupplier condition,
final Supplier<PageAction> actionSupplier) {
if (condition.getAsBoolean()) {
return withDefaultAction(actionSupplier.get());
}
return this;
}
public TableBuilder<ROW> withDefaultAction(final PageAction action) {
this.defaultActionFunction = table -> PageAction.copyOf(action);
return this;
}
public TableBuilder<ROW> withDefaultActionIf(
final BooleanSupplier condition,
final Function<EntityTable<ROW>, PageAction> defaultActionFunction) {
if (condition.getAsBoolean()) {
return withDefaultAction(defaultActionFunction);
}
return this;
}
public TableBuilder<ROW> withDefaultAction(final Function<EntityTable<ROW>, PageAction> defaultActionFunction) {
this.defaultActionFunction = defaultActionFunction;
return this;
}
public TableBuilder<ROW> withRowDecorator(final BiConsumer<TableItem, ROW> rowDecorator) {
this.rowDecorator = rowDecorator;
return this;
}
public EntityTable<ROW> compose(final PageContext pageContext) {
return new EntityTable<>(
this.name,
this.markupEnabled,
this.type,
pageContext,
this.restCall,
this.restCallAdapter,
this.pageService,
this.columns,
this.pageSize,
this.emptyMessage,
this.defaultActionFunction,
this.hideNavigation,
this.staticQueryParams,
this.rowDecorator,
this.selectionListener);
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.table;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.BooleanSupplier;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.TableItem;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import ch.ethz.seb.sebserver.gbl.model.Entity;
import ch.ethz.seb.sebserver.gbl.model.Page;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.page.PageContext;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.service.page.impl.PageAction;
import ch.ethz.seb.sebserver.gui.service.remote.webservice.api.RestCall;
public class TableBuilder<ROW extends Entity> {
private final String name;
private final PageService pageService;
final RestCall<Page<ROW>> restCall;
private final MultiValueMap<String, String> staticQueryParams;
final List<ColumnDefinition<ROW>> columns = new ArrayList<>();
LocTextKey emptyMessage;
private Function<EntityTable<ROW>, PageAction> defaultActionFunction;
private int pageSize = -1;
private int type = SWT.NONE;
private boolean hideNavigation = false;
private Function<RestCall<Page<ROW>>.RestCallBuilder, RestCall<Page<ROW>>.RestCallBuilder> restCallAdapter;
private BiConsumer<TableItem, ROW> rowDecorator;
private Consumer<Set<ROW>> selectionListener;
private boolean markupEnabled = false;
public TableBuilder(
final String name,
final PageService pageService,
final RestCall<Page<ROW>> restCall) {
this.name = name;
this.pageService = pageService;
this.restCall = restCall;
this.staticQueryParams = new LinkedMultiValueMap<>();
}
public TableBuilder<ROW> hideNavigation() {
this.hideNavigation = true;
return this;
}
public TableBuilder<ROW> withEmptyMessage(final LocTextKey emptyMessage) {
this.emptyMessage = emptyMessage;
return this;
}
public TableBuilder<ROW> withPaging(final int pageSize) {
this.pageSize = pageSize;
return this;
}
public TableBuilder<ROW> withColumn(final ColumnDefinition<ROW> columnDefinition) {
this.columns.add(columnDefinition);
return this;
}
public TableBuilder<ROW> withMarkup() {
this.markupEnabled = true;
return this;
}
public TableBuilder<ROW> withColumnIf(
final BooleanSupplier condition,
final Supplier<ColumnDefinition<ROW>> columnDefSupplier) {
if (condition != null && condition.getAsBoolean()) {
this.columns.add(columnDefSupplier.get());
}
return this;
}
public TableBuilder<ROW> withRestCallAdapter(
final Function<RestCall<Page<ROW>>.RestCallBuilder, RestCall<Page<ROW>>.RestCallBuilder> adapter) {
this.restCallAdapter = adapter;
return this;
}
public TableBuilder<ROW> withMultiSelection() {
this.type |= SWT.MULTI;
return this;
}
public TableBuilder<ROW> withSelectionListener(final Consumer<Set<ROW>> selectionListener) {
this.selectionListener = selectionListener;
return this;
}
public TableBuilder<ROW> withStaticFilter(final String name, final String value) {
this.staticQueryParams.add(name, value);
return this;
}
public TableBuilder<ROW> withDefaultActionIf(
final BooleanSupplier condition,
final Supplier<PageAction> actionSupplier) {
if (condition.getAsBoolean()) {
return withDefaultAction(actionSupplier.get());
}
return this;
}
public TableBuilder<ROW> withDefaultAction(final PageAction action) {
this.defaultActionFunction = table -> PageAction.copyOf(action);
return this;
}
public TableBuilder<ROW> withDefaultActionIf(
final BooleanSupplier condition,
final Function<EntityTable<ROW>, PageAction> defaultActionFunction) {
if (condition.getAsBoolean()) {
return withDefaultAction(defaultActionFunction);
}
return this;
}
public TableBuilder<ROW> withDefaultAction(final Function<EntityTable<ROW>, PageAction> defaultActionFunction) {
this.defaultActionFunction = defaultActionFunction;
return this;
}
public TableBuilder<ROW> withRowDecorator(final BiConsumer<TableItem, ROW> rowDecorator) {
this.rowDecorator = rowDecorator;
return this;
}
public EntityTable<ROW> compose(final PageContext pageContext) {
return new EntityTable<>(
this.name,
this.markupEnabled,
this.type,
pageContext,
this.restCall,
this.restCallAdapter,
this.pageService,
this.columns,
this.pageSize,
this.emptyMessage,
this.defaultActionFunction,
this.hideNavigation,
this.staticQueryParams,
this.rowDecorator,
this.selectionListener);
}
}

35
src/main/java/ch/ethz/seb/sebserver/gui/table/TableFilter.java
View file

@ -49,7 +49,7 @@ public class TableFilter<ROW extends Entity> {
private static final LocTextKey DATE_TO_TEXT = new LocTextKey("sebserver.overall.date.to");
private static final LocTextKey ALL_TEXT = new LocTextKey("sebserver.overall.status.all");
public static enum CriteriaType {
public enum CriteriaType {
TEXT,
SINGLE_SELECTION,
DATE,
@ -82,7 +82,7 @@ public class TableFilter<ROW extends Entity> {
public MultiValueMap<String, String> getFilterParameter() {
return this.components
.stream()
.reduce(new LinkedMultiValueMap<String, String>(),
.reduce(new LinkedMultiValueMap<>(),
(map, comp) -> comp.putFilterParameter(map),
(map1, map2) -> {
map1.putAll(map2);
@ -92,8 +92,7 @@ public class TableFilter<ROW extends Entity> {
public void reset() {
this.components
.stream()
.forEach(comp -> comp.reset());
.forEach(FilterComponent::reset);
}
private void buildComponents() {
@ -158,7 +157,7 @@ public class TableFilter<ROW extends Entity> {
.append(Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR)
.append(filter.getValue())
.append(Constants.LIST_SEPARATOR),
(sb1, sb2) -> sb1.append(sb2));
StringBuilder::append);
if (builder.length() > 0) {
builder.deleteCharAt(builder.length() - 1);
}
@ -171,22 +170,19 @@ public class TableFilter<ROW extends Entity> {
}
try {
Arrays.asList(StringUtils.split(
Arrays.stream(StringUtils.split(
attribute,
Constants.LIST_SEPARATOR_CHAR))
.stream()
.map(nameValue -> StringUtils.split(
nameValue,
Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR))
.forEach(nameValue -> {
this.components
.stream()
.filter(filter -> nameValue[0].equals(filter.attribute.columnName))
.findFirst()
.ifPresent(filter -> filter.setValue((nameValue.length > 1)
? nameValue[1]
: StringUtils.EMPTY));
});
.forEach(nameValue -> this.components
.stream()
.filter(filter -> nameValue[0].equals(filter.attribute.columnName))
.findFirst()
.ifPresent(filter -> filter.setValue((nameValue.length > 1)
? nameValue[1]
: StringUtils.EMPTY)));
} catch (final Exception e) {
log.error("Failed to set filter attributes: ", e);
}
@ -208,9 +204,7 @@ public class TableFilter<ROW extends Entity> {
ImageIcon.SEARCH,
inner,
new LocTextKey("sebserver.overall.action.filter"),
event -> {
this.entityTable.applyFilter();
});
event -> this.entityTable.applyFilter());
imageButton.setLayoutData(gridData);
final Label imageButton2 = this.entityTable.widgetFactory.imageButton(
ImageIcon.CANCEL,
@ -276,7 +270,7 @@ public class TableFilter<ROW extends Entity> {
}
}
private class NullFilter extends FilterComponent {
private static class NullFilter extends FilterComponent {
private Label label;
@ -493,7 +487,6 @@ public class TableFilter<ROW extends Entity> {
private class DateRange extends FilterComponent {
private Composite innerComposite;
//private final GridData rw1 = new GridData(SWT.FILL, SWT.FILL, true, true);
private DateTime fromDateSelector;
private DateTime toDateSelector;
private DateTime fromTimeSelector;

368
src/main/java/ch/ethz/seb/sebserver/gui/table/TableNavigator.java
View file

@ -1,189 +1,179 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.table;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import ch.ethz.seb.sebserver.gbl.model.Page;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.CustomVariant;
public class TableNavigator {
private final static int PAGE_NAV_SIZE = 9;
private final Composite composite;
private final EntityTable<?> entityTable;
TableNavigator(final EntityTable<?> entityTable) {
this.composite = new Composite(entityTable.composite, SWT.NONE);
final GridData gridData = new GridData(SWT.LEFT, SWT.CENTER, true, true);
this.composite.setLayoutData(gridData);
final GridLayout layout = new GridLayout(3, false);
this.composite.setLayout(layout);
this.entityTable = entityTable;
}
public Page<?> update(final Page<?> pageData) {
// clear all
PageService.clearComposite(this.composite);
if (pageData.isEmpty()) {
// show empty message
if (this.entityTable.emptyMessage != null) {
this.entityTable.widgetFactory.labelLocalized(
this.composite,
CustomVariant.TEXT_H3,
this.entityTable.emptyMessage);
}
return pageData;
}
if (this.entityTable.hideNavigation) {
return pageData;
}
final int pageNumber = pageData.getPageNumber();
final int numberOfPages = pageData.getNumberOfPages();
createPagingHeader(pageNumber, numberOfPages);
final Composite numNav = new Composite(this.composite, SWT.NONE);
final GridData gridData = new GridData(SWT.CENTER, SWT.TOP, true, false);
numNav.setLayoutData(gridData);
final GridLayout rowLayout = new GridLayout(PAGE_NAV_SIZE + 5, true);
numNav.setLayout(rowLayout);
if (numberOfPages > 1) {
createBackwardLabel(pageNumber > 1, pageNumber, numNav);
final int pageNavSize = (numberOfPages > PAGE_NAV_SIZE) ? PAGE_NAV_SIZE : numberOfPages;
final int half = pageNavSize / 2;
int start = pageNumber - half;
if (start < 1) {
start = 1;
}
int end = start + pageNavSize;
if (end > numberOfPages) {
end = numberOfPages + 1;
start = end - pageNavSize;
}
for (int i = start; i < end; i++) {
createPageNumberLabel(i, i != pageNumber, numNav);
}
createForwardLabel(pageNumber < numberOfPages, pageNumber, numberOfPages, numNav);
}
return pageData;
}
private void createPagingHeader(final int page, final int of) {
final Label pageHeader = new Label(this.composite, SWT.NONE);
final GridData gridData = new GridData(SWT.CENTER, SWT.CENTER, true, false);
gridData.widthHint = 100;
gridData.minimumWidth = 100;
gridData.heightHint = 16;
pageHeader.setLayoutData(gridData);
pageHeader.setText("Page " + page + " / " + of);
}
private void createPageNumberLabel(
final int page,
final boolean selectable,
final Composite parent) {
final GridData rowData = new GridData(22, 16);
final Label pageLabel = new Label(parent, SWT.NONE);
pageLabel.setText(" " + String.valueOf(page) + " ");
pageLabel.setLayoutData(rowData);
pageLabel.setAlignment(SWT.CENTER);
if (selectable) {
pageLabel.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
pageLabel.addListener(SWT.MouseDown, event -> {
this.entityTable.selectPage(page);
});
}
}
private void createForwardLabel(
final boolean visible,
final int pageNumber,
final int numberOfPages,
final Composite parent) {
final GridData rowData = new GridData(22, 16);
final Label forward = new Label(parent, SWT.NONE);
forward.setText(">");
forward.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
forward.setLayoutData(rowData);
forward.setAlignment(SWT.CENTER);
if (visible) {
forward.addListener(SWT.MouseDown, event -> {
this.entityTable.selectPage(pageNumber + 1);
});
} else {
forward.setVisible(false);
}
final Label end = new Label(parent, SWT.NONE);
end.setText(">>");
end.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
end.setLayoutData(rowData);
end.setAlignment(SWT.CENTER);
if (visible) {
end.addListener(SWT.MouseDown, event -> {
this.entityTable.selectPage(numberOfPages);
});
} else {
end.setVisible(false);
}
}
private void createBackwardLabel(
final boolean visible,
final int pageNumber,
final Composite parent) {
final GridData rowData = new GridData(22, 16);
final Label start = new Label(parent, SWT.NONE);
start.setText("<<");
start.setLayoutData(rowData);
start.setAlignment(SWT.CENTER);
start.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
if (visible) {
start.addListener(SWT.MouseDown, event -> {
this.entityTable.selectPage(1);
});
} else {
start.setVisible(false);
}
final Label backward = new Label(parent, SWT.NONE);
backward.setText("<");
backward.setLayoutData(rowData);
backward.setAlignment(SWT.CENTER);
backward.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
if (visible) {
backward.addListener(SWT.MouseDown, event -> {
this.entityTable.selectPage(pageNumber - 1);
});
} else {
backward.setVisible(false);
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.table;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import ch.ethz.seb.sebserver.gbl.model.Page;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.CustomVariant;
public class TableNavigator {
private final static int PAGE_NAV_SIZE = 9;
private final Composite composite;
private final EntityTable<?> entityTable;
TableNavigator(final EntityTable<?> entityTable) {
this.composite = new Composite(entityTable.composite, SWT.NONE);
final GridData gridData = new GridData(SWT.LEFT, SWT.CENTER, true, true);
this.composite.setLayoutData(gridData);
final GridLayout layout = new GridLayout(3, false);
this.composite.setLayout(layout);
this.entityTable = entityTable;
}
public Page<?> update(final Page<?> pageData) {
// clear all
PageService.clearComposite(this.composite);
if (pageData.isEmpty()) {
// show empty message
if (this.entityTable.emptyMessage != null) {
this.entityTable.widgetFactory.labelLocalized(
this.composite,
CustomVariant.TEXT_H3,
this.entityTable.emptyMessage);
}
return pageData;
}
if (this.entityTable.hideNavigation) {
return pageData;
}
final int pageNumber = pageData.getPageNumber();
final int numberOfPages = pageData.getNumberOfPages();
createPagingHeader(pageNumber, numberOfPages);
final Composite numNav = new Composite(this.composite, SWT.NONE);
final GridData gridData = new GridData(SWT.CENTER, SWT.TOP, true, false);
numNav.setLayoutData(gridData);
final GridLayout rowLayout = new GridLayout(PAGE_NAV_SIZE + 5, true);
numNav.setLayout(rowLayout);
if (numberOfPages > 1) {
createBackwardLabel(pageNumber > 1, pageNumber, numNav);
final int pageNavSize = Math.min(numberOfPages, PAGE_NAV_SIZE);
final int half = pageNavSize / 2;
int start = pageNumber - half;
if (start < 1) {
start = 1;
}
int end = start + pageNavSize;
if (end > numberOfPages) {
end = numberOfPages + 1;
start = end - pageNavSize;
}
for (int i = start; i < end; i++) {
createPageNumberLabel(i, i != pageNumber, numNav);
}
createForwardLabel(pageNumber < numberOfPages, pageNumber, numberOfPages, numNav);
}
return pageData;
}
private void createPagingHeader(final int page, final int of) {
final Label pageHeader = new Label(this.composite, SWT.NONE);
final GridData gridData = new GridData(SWT.CENTER, SWT.CENTER, true, false);
gridData.widthHint = 100;
gridData.minimumWidth = 100;
gridData.heightHint = 16;
pageHeader.setLayoutData(gridData);
pageHeader.setText("Page " + page + " / " + of);
}
private void createPageNumberLabel(
final int page,
final boolean selectable,
final Composite parent) {
final GridData rowData = new GridData(22, 16);
final Label pageLabel = new Label(parent, SWT.NONE);
pageLabel.setText(" " + page + " ");
pageLabel.setLayoutData(rowData);
pageLabel.setAlignment(SWT.CENTER);
if (selectable) {
pageLabel.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
pageLabel.addListener(SWT.MouseDown, event -> this.entityTable.selectPage(page));
}
}
private void createForwardLabel(
final boolean visible,
final int pageNumber,
final int numberOfPages,
final Composite parent) {
final GridData rowData = new GridData(22, 16);
final Label forward = new Label(parent, SWT.NONE);
forward.setText(">");
forward.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
forward.setLayoutData(rowData);
forward.setAlignment(SWT.CENTER);
if (visible) {
forward.addListener(SWT.MouseDown, event -> this.entityTable.selectPage(pageNumber + 1));
} else {
forward.setVisible(false);
}
final Label end = new Label(parent, SWT.NONE);
end.setText(">>");
end.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
end.setLayoutData(rowData);
end.setAlignment(SWT.CENTER);
if (visible) {
end.addListener(SWT.MouseDown, event -> this.entityTable.selectPage(numberOfPages));
} else {
end.setVisible(false);
}
}
private void createBackwardLabel(
final boolean visible,
final int pageNumber,
final Composite parent) {
final GridData rowData = new GridData(22, 16);
final Label start = new Label(parent, SWT.NONE);
start.setText("<<");
start.setLayoutData(rowData);
start.setAlignment(SWT.CENTER);
start.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
if (visible) {
start.addListener(SWT.MouseDown, event -> this.entityTable.selectPage(1));
} else {
start.setVisible(false);
}
final Label backward = new Label(parent, SWT.NONE);
backward.setText("<");
backward.setLayoutData(rowData);
backward.setAlignment(SWT.CENTER);
backward.setData(RWT.CUSTOM_VARIANT, CustomVariant.LIST_NAVIGATION.key);
if (visible) {
backward.addListener(SWT.MouseDown, event -> this.entityTable.selectPage(pageNumber - 1));
} else {
backward.setVisible(false);
}
}
}

406
src/main/java/ch/ethz/seb/sebserver/gui/widget/FileUploadSelection.java
View file

@ -1,204 +1,202 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.io.IOException;
import java.io.InputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.function.Consumer;
import org.apache.commons.io.IOUtils;
import org.eclipse.rap.fileupload.FileDetails;
import org.eclipse.rap.fileupload.FileUploadHandler;
import org.eclipse.rap.fileupload.FileUploadReceiver;
import org.eclipse.rap.rwt.widgets.FileUpload;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
public class FileUploadSelection extends Composite {
private static final Logger log = LoggerFactory.getLogger(FileUploadSelection.class);
private static final long serialVersionUID = 5800153475027387363L;
private static final LocTextKey PLEASE_SELECT_TEXT =
new LocTextKey("sebserver.overall.upload");
private final I18nSupport i18nSupport;
private final List<String> supportedFileExtensions = new ArrayList<>();
private final boolean readonly;
private final FileUpload fileUpload;
private final Label fileName;
private Consumer<String> errorHandler;
private InputStream inputStream;
private final FileUploadHandler uploadHandler;
private final InputReceiver inputReceiver;
public FileUploadSelection(
final Composite parent,
final I18nSupport i18nSupport,
final boolean readonly) {
super(parent, SWT.NONE);
final GridLayout gridLayout = new GridLayout(2, false);
gridLayout.horizontalSpacing = 0;
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
gridLayout.verticalSpacing = 0;
super.setLayout(gridLayout);
this.i18nSupport = i18nSupport;
this.readonly = readonly;
if (readonly) {
this.fileName = new Label(this, SWT.NONE);
this.fileName.setText(i18nSupport.getText(PLEASE_SELECT_TEXT));
this.fileName.setLayoutData(new GridData());
this.fileUpload = null;
this.uploadHandler = null;
this.inputReceiver = null;
} else {
this.fileUpload = new FileUpload(this, SWT.NONE);
this.fileUpload.setImage(WidgetFactory.ImageIcon.IMPORT.getImage(parent.getDisplay()));
this.fileUpload.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, false, false));
this.fileUpload.setToolTipText(Utils.formatLineBreaks(this.i18nSupport.getText(PLEASE_SELECT_TEXT)));
this.inputReceiver = new InputReceiver();
this.uploadHandler = new FileUploadHandler(this.inputReceiver);
this.fileName = new Label(this, SWT.NONE);
this.fileName.setText(i18nSupport.getText(PLEASE_SELECT_TEXT));
this.fileName.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
this.fileUpload.addListener(SWT.Selection, event -> {
final String fileName = FileUploadSelection.this.fileUpload.getFileName();
if (fileName == null || !fileSupported(fileName)) {
if (FileUploadSelection.this.errorHandler != null) {
final String text = i18nSupport.getText(new LocTextKey(
"sebserver.overall.upload.unsupported.file",
this.supportedFileExtensions.toString()),
"Unsupported image file type selected");
FileUploadSelection.this.errorHandler.accept(text);
}
return;
}
FileUploadSelection.this.fileUpload.submit(this.uploadHandler.getUploadUrl());
FileUploadSelection.this.fileName.setText(fileName);
FileUploadSelection.this.errorHandler.accept(null);
});
}
}
public void close() {
if (this.inputReceiver != null) {
this.inputReceiver.close();
}
}
@Override
public void dispose() {
if (this.uploadHandler != null) {
this.uploadHandler.dispose();
}
super.dispose();
}
public String getFileName() {
if (this.fileName != null) {
return this.fileName.getText();
}
return Constants.EMPTY_NOTE;
}
public void setFileName(final String fileName) {
if (this.fileName != null && fileName != null) {
this.fileName.setText(fileName);
}
}
public InputStream getInputStream() {
return this.inputStream;
}
@Override
public void update() {
if (this.inputStream != null) {
this.fileName.setText(this.i18nSupport.getText(PLEASE_SELECT_TEXT));
}
if (!this.readonly) {
this.fileUpload.setToolTipText(Utils.formatLineBreaks(this.i18nSupport.getText(PLEASE_SELECT_TEXT)));
}
}
public FileUploadSelection setErrorHandler(final Consumer<String> errorHandler) {
this.errorHandler = errorHandler;
return this;
}
public FileUploadSelection withSupportFor(final String fileExtension) {
this.supportedFileExtensions.add(fileExtension);
return this;
}
private boolean fileSupported(final String fileName) {
return this.supportedFileExtensions
.stream()
.filter(fileType -> fileName.toUpperCase(Locale.ROOT)
.endsWith(fileType.toUpperCase(Locale.ROOT)))
.findFirst()
.isPresent();
}
private final class InputReceiver extends FileUploadReceiver {
private PipedInputStream pIn = null;
private PipedOutputStream pOut = null;
@Override
public void receive(final InputStream stream, final FileDetails details) throws IOException {
if (this.pIn != null || this.pOut != null) {
throw new IllegalStateException("InputReceiver already in use");
}
this.pIn = new PipedInputStream();
this.pOut = new PipedOutputStream(this.pIn);
FileUploadSelection.this.inputStream = this.pIn;
try {
IOUtils.copyLarge(stream, this.pOut);
} catch (final Exception e) {
log.warn("IO error: {}", e.getMessage());
} finally {
close();
}
}
void close() {
IOUtils.closeQuietly(this.pOut);
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.io.IOException;
import java.io.InputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.function.Consumer;
import org.apache.commons.io.IOUtils;
import org.eclipse.rap.fileupload.FileDetails;
import org.eclipse.rap.fileupload.FileUploadHandler;
import org.eclipse.rap.fileupload.FileUploadReceiver;
import org.eclipse.rap.rwt.widgets.FileUpload;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
public class FileUploadSelection extends Composite {
private static final Logger log = LoggerFactory.getLogger(FileUploadSelection.class);
private static final long serialVersionUID = 5800153475027387363L;
private static final LocTextKey PLEASE_SELECT_TEXT =
new LocTextKey("sebserver.overall.upload");
private final I18nSupport i18nSupport;
private final List<String> supportedFileExtensions = new ArrayList<>();
private final boolean readonly;
private final FileUpload fileUpload;
private final Label fileName;
private Consumer<String> errorHandler;
private InputStream inputStream;
private final FileUploadHandler uploadHandler;
private final InputReceiver inputReceiver;
public FileUploadSelection(
final Composite parent,
final I18nSupport i18nSupport,
final boolean readonly) {
super(parent, SWT.NONE);
final GridLayout gridLayout = new GridLayout(2, false);
gridLayout.horizontalSpacing = 0;
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
gridLayout.verticalSpacing = 0;
super.setLayout(gridLayout);
this.i18nSupport = i18nSupport;
this.readonly = readonly;
if (readonly) {
this.fileName = new Label(this, SWT.NONE);
this.fileName.setText(i18nSupport.getText(PLEASE_SELECT_TEXT));
this.fileName.setLayoutData(new GridData());
this.fileUpload = null;
this.uploadHandler = null;
this.inputReceiver = null;
} else {
this.fileUpload = new FileUpload(this, SWT.NONE);
this.fileUpload.setImage(WidgetFactory.ImageIcon.IMPORT.getImage(parent.getDisplay()));
this.fileUpload.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, false, false));
this.fileUpload.setToolTipText(Utils.formatLineBreaks(this.i18nSupport.getText(PLEASE_SELECT_TEXT)));
this.inputReceiver = new InputReceiver();
this.uploadHandler = new FileUploadHandler(this.inputReceiver);
this.fileName = new Label(this, SWT.NONE);
this.fileName.setText(i18nSupport.getText(PLEASE_SELECT_TEXT));
this.fileName.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
this.fileUpload.addListener(SWT.Selection, event -> {
final String fileName = FileUploadSelection.this.fileUpload.getFileName();
if (fileName == null || !fileSupported(fileName)) {
if (FileUploadSelection.this.errorHandler != null) {
final String text = i18nSupport.getText(new LocTextKey(
"sebserver.overall.upload.unsupported.file",
this.supportedFileExtensions.toString()),
"Unsupported image file type selected");
FileUploadSelection.this.errorHandler.accept(text);
}
return;
}
FileUploadSelection.this.fileUpload.submit(this.uploadHandler.getUploadUrl());
FileUploadSelection.this.fileName.setText(fileName);
FileUploadSelection.this.errorHandler.accept(null);
});
}
}
public void close() {
if (this.inputReceiver != null) {
this.inputReceiver.close();
}
}
@Override
public void dispose() {
if (this.uploadHandler != null) {
this.uploadHandler.dispose();
}
super.dispose();
}
public String getFileName() {
if (this.fileName != null) {
return this.fileName.getText();
}
return Constants.EMPTY_NOTE;
}
public void setFileName(final String fileName) {
if (this.fileName != null && fileName != null) {
this.fileName.setText(fileName);
}
}
public InputStream getInputStream() {
return this.inputStream;
}
@Override
public void update() {
if (this.inputStream != null) {
this.fileName.setText(this.i18nSupport.getText(PLEASE_SELECT_TEXT));
}
if (!this.readonly) {
this.fileUpload.setToolTipText(Utils.formatLineBreaks(this.i18nSupport.getText(PLEASE_SELECT_TEXT)));
}
}
public FileUploadSelection setErrorHandler(final Consumer<String> errorHandler) {
this.errorHandler = errorHandler;
return this;
}
public FileUploadSelection withSupportFor(final String fileExtension) {
this.supportedFileExtensions.add(fileExtension);
return this;
}
private boolean fileSupported(final String fileName) {
return this.supportedFileExtensions
.stream()
.anyMatch(fileType -> fileName.toUpperCase(Locale.ROOT)
.endsWith(fileType.toUpperCase(Locale.ROOT)));
}
private final class InputReceiver extends FileUploadReceiver {
private PipedInputStream pIn = null;
private PipedOutputStream pOut = null;
@Override
public void receive(final InputStream stream, final FileDetails details) throws IOException {
if (this.pIn != null || this.pOut != null) {
throw new IllegalStateException("InputReceiver already in use");
}
this.pIn = new PipedInputStream();
this.pOut = new PipedOutputStream(this.pIn);
FileUploadSelection.this.inputStream = this.pIn;
try {
IOUtils.copyLarge(stream, this.pOut);
} catch (final Exception e) {
log.warn("IO error: {}", e.getMessage());
} finally {
close();
}
}
void close() {
IOUtils.closeQuietly(this.pOut);
}
}
}

843
src/main/java/ch/ethz/seb/sebserver/gui/widget/GridTable.java
View file

@ -1,422 +1,421 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Text;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.model.sebconfig.AttributeType;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.CustomVariant;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.ImageIcon;
public class GridTable extends Composite {
private static final long serialVersionUID = 8515260041931976458L;
private static final Logger log = LoggerFactory.getLogger(GridTable.class);
public static final Set<AttributeType> SUPPORTED_TYPES = EnumSet.of(
AttributeType.CHECKBOX,
AttributeType.TEXT_FIELD);
private static final int ACTION_COLUMN_WIDTH = 20;
private final WidgetFactory widgetFactory;
private final List<Column> columns;
private final Label addAction;
private final List<Row> rows;
private final String locTextKeyPrefix;
private Listener listener;
public GridTable(
final Composite parent,
final List<ColumnDef> columnDefs,
final String locTextKeyPrefix,
final WidgetFactory widgetFactory) {
super(parent, SWT.NONE);
this.widgetFactory = widgetFactory;
this.locTextKeyPrefix = locTextKeyPrefix;
final GridLayout gridLayout = new GridLayout(columnDefs.size() + 1, false);
gridLayout.verticalSpacing = 1;
gridLayout.marginLeft = 0;
gridLayout.marginHeight = 5;
gridLayout.marginWidth = 0;
gridLayout.horizontalSpacing = 0;
this.setLayout(gridLayout);
this.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
this.columns = new ArrayList<>();
for (final ColumnDef columnDef : columnDefs) {
final Label label = widgetFactory.labelLocalized(
this,
new LocTextKey(locTextKeyPrefix + columnDef.name));
final GridData gridData = new GridData(SWT.FILL, SWT.FILL, true, true);
label.setLayoutData(gridData);
this.columns.add(new Column(columnDef, gridData));
}
this.addAction = widgetFactory.imageButton(
ImageIcon.ADD_BOX,
this,
new LocTextKey(locTextKeyPrefix + "addAction"),
this::addRow);
final GridData gridData = new GridData(SWT.CENTER, SWT.FILL, true, true);
gridData.widthHint = ACTION_COLUMN_WIDTH;
this.addAction.setLayoutData(gridData);
this.rows = new ArrayList<>();
this.addListener(SWT.Resize, this::adaptColumnWidth);
}
public void setListener(final Listener listener) {
this.listener = listener;
}
void addRow(final Event event) {
final List<ControlAdapter> row = new ArrayList<>();
for (final Column column : this.columns) {
row.add(createCell(column, column.columnDef.defaultValue));
}
this.rows.add(new Row(row));
this.adaptLayout();
if (this.listener != null) {
this.listener.handleEvent(new Event());
}
}
public void adaptLayout() {
this.getParent().getParent().layout(true, true);
PageService.updateScrolledComposite(this);
}
void addRow(final String values) {
if (StringUtils.isBlank(values)) {
return;
}
final Map<String, String> nameValueMap = new HashMap<>();
for (final String valueMap : StringUtils.split(values, Constants.EMBEDDED_LIST_SEPARATOR)) {
final String[] nameValue = StringUtils.split(valueMap, Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR);
if (nameValue.length > 1) {
nameValueMap.put(nameValue[0], nameValue[1]);
} else {
nameValueMap.put(nameValue[0], null);
}
}
final List<ControlAdapter> row = new ArrayList<>();
for (final Column column : this.columns) {
row.add(createCell(column, nameValueMap.get(column.columnDef.name)));
}
this.rows.add(new Row(row));
}
void deleteRow(final Row row) {
if (this.rows.remove(row)) {
row.dispose();
}
this.adaptLayout();
}
public String getValue() {
return StringUtils.join(
this.rows
.stream()
.map(row -> row.getValue())
.collect(Collectors.toList()),
Constants.LIST_SEPARATOR);
}
public void setValue(final String value) {
clearTable();
if (StringUtils.isBlank(value)) {
return;
}
for (final String val : StringUtils.split(value, Constants.LIST_SEPARATOR)) {
addRow(val);
}
this.adaptLayout();
}
private ControlAdapter createCell(final Column column, final String value) {
switch (column.columnDef.type) {
case CHECKBOX: {
final CheckBox checkBox = new CheckBox(this, column.columnDef, this.listener);
checkBox.setValue(value);
return checkBox;
}
case TEXT_FIELD: {
final TextField textField = new TextField(this, column.columnDef, this.listener);
textField.setValue(value);
return textField;
}
default: {
return new Dummy(this, column.columnDef);
}
}
}
private void clearTable() {
for (final Row row : this.rows) {
row.dispose();
}
this.rows.clear();
}
private void adaptColumnWidth(final Event event) {
try {
final int currentTableWidth = super.getClientArea().width - ACTION_COLUMN_WIDTH;
final int widthUnit = currentTableWidth / this.columns
.stream()
.reduce(0,
(i, c2) -> i + c2.columnDef.widthFactor,
(i1, i2) -> i1 + i2);
this.columns
.stream()
.forEach(c -> c.header.widthHint = c.columnDef.widthFactor * widthUnit);
super.layout(true, true);
} catch (final Exception e) {
log.warn("Failed to adaptColumnWidth: ", e);
}
}
final class Row {
final List<ControlAdapter> cells;
final Label removeAction;
protected Row(final List<ControlAdapter> cells) {
this.cells = cells;
this.removeAction = GridTable.this.widgetFactory.imageButton(
ImageIcon.REMOVE_BOX,
GridTable.this,
new LocTextKey(GridTable.this.locTextKeyPrefix + "removeAction"),
event -> deleteRow(this));
final GridData gridData = new GridData(SWT.CENTER, SWT.CENTER, true, true);
gridData.widthHint = ACTION_COLUMN_WIDTH;
this.removeAction.setLayoutData(gridData);
}
void dispose() {
for (final ControlAdapter cell : this.cells) {
cell.dispose();
}
this.removeAction.dispose();
}
String getValue() {
return StringUtils.join(
this.cells
.stream()
.map(cell -> cell.columnDef().name + Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR
+ cell.getValue())
.collect(Collectors.toList()),
Constants.EMBEDDED_LIST_SEPARATOR);
}
}
public static final class ColumnDef {
final int widthFactor;
final String name;
final AttributeType type;
final String defaultValue;
protected ColumnDef(
final int widthFactor,
final String name,
final AttributeType type,
final String defaultValue) {
this.widthFactor = widthFactor;
this.name = name;
this.type = type;
this.defaultValue = defaultValue;
}
public static final ColumnDef fromString(
final String string,
final Map<String, String> defaultValueMap) {
if (StringUtils.isBlank(string)) {
return null;
}
final String[] split = StringUtils.split(string, Constants.COMPLEX_VALUE_SEPARATOR);
final AttributeType attributeType = AttributeType.valueOf(split[2]);
if (!SUPPORTED_TYPES.contains(attributeType)) {
throw new UnsupportedOperationException(
"The AttributeType : " + attributeType + " is not supported yet");
}
return new ColumnDef(
Integer.parseInt(split[0]),
split[1],
attributeType,
defaultValueMap.get(split[1]));
}
}
private static class Column {
final ColumnDef columnDef;
final GridData header;
protected Column(final ColumnDef columnDef, final GridData header) {
this.columnDef = columnDef;
this.header = header;
}
}
interface ControlAdapter {
String getValue();
void setValue(String value);
void dispose();
ColumnDef columnDef();
}
private static class Dummy implements ControlAdapter {
private final Label label;
private final ColumnDef columnDef;
Dummy(final Composite parent, final ColumnDef columnDef) {
this.label = new Label(parent, SWT.NONE);
this.label.setText("unsupported");
this.columnDef = columnDef;
}
@Override
public String getValue() {
return null;
}
@Override
public void setValue(final String value) {
}
@Override
public void dispose() {
this.label.dispose();
}
@Override
public ColumnDef columnDef() {
return this.columnDef;
}
}
private static class CheckBox implements ControlAdapter {
private final Button checkboxButton;
private final ColumnDef columnDef;
CheckBox(final Composite parent, final ColumnDef columnDef, final Listener listener) {
this.checkboxButton = new Button(parent, SWT.CHECK);
this.checkboxButton.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
this.columnDef = columnDef;
if (listener != null) {
this.checkboxButton.addListener(SWT.Selection, listener);
}
}
@Override
public String getValue() {
return this.checkboxButton.getSelection()
? Constants.TRUE_STRING
: Constants.FALSE_STRING;
}
@Override
public void setValue(final String value) {
this.checkboxButton.setSelection(BooleanUtils.toBoolean(value));
}
@Override
public void dispose() {
this.checkboxButton.dispose();
}
@Override
public ColumnDef columnDef() {
return this.columnDef;
}
}
private static class TextField implements ControlAdapter {
private final Text _textField;
private final ColumnDef columnDef;
TextField(final Composite parent, final ColumnDef columnDef, final Listener listener) {
this._textField = new Text(parent, SWT.LEFT | SWT.BORDER);
this._textField.setData(RWT.CUSTOM_VARIANT, CustomVariant.CONFIG_INPUT_READONLY.key);
this._textField.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
this.columnDef = columnDef;
this._textField.addListener(SWT.FocusOut, listener);
this._textField.addListener(SWT.Traverse, listener);
}
@Override
public String getValue() {
return this._textField.getText();
}
@Override
public void setValue(final String value) {
this._textField.setText((value != null) ? value : "");
}
@Override
public void dispose() {
this._textField.dispose();
}
@Override
public ColumnDef columnDef() {
return this.columnDef;
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Text;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.model.sebconfig.AttributeType;
import ch.ethz.seb.sebserver.gui.service.i18n.LocTextKey;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.CustomVariant;
import ch.ethz.seb.sebserver.gui.widget.WidgetFactory.ImageIcon;
public class GridTable extends Composite {
private static final long serialVersionUID = 8515260041931976458L;
private static final Logger log = LoggerFactory.getLogger(GridTable.class);
public static final Set<AttributeType> SUPPORTED_TYPES = EnumSet.of(
AttributeType.CHECKBOX,
AttributeType.TEXT_FIELD);
private static final int ACTION_COLUMN_WIDTH = 20;
private final WidgetFactory widgetFactory;
private final List<Column> columns;
private final Label addAction;
private final List<Row> rows;
private final String locTextKeyPrefix;
private Listener listener;
public GridTable(
final Composite parent,
final List<ColumnDef> columnDefs,
final String locTextKeyPrefix,
final WidgetFactory widgetFactory) {
super(parent, SWT.NONE);
this.widgetFactory = widgetFactory;
this.locTextKeyPrefix = locTextKeyPrefix;
final GridLayout gridLayout = new GridLayout(columnDefs.size() + 1, false);
gridLayout.verticalSpacing = 1;
gridLayout.marginLeft = 0;
gridLayout.marginHeight = 5;
gridLayout.marginWidth = 0;
gridLayout.horizontalSpacing = 0;
this.setLayout(gridLayout);
this.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
this.columns = new ArrayList<>();
for (final ColumnDef columnDef : columnDefs) {
final Label label = widgetFactory.labelLocalized(
this,
new LocTextKey(locTextKeyPrefix + columnDef.name));
final GridData gridData = new GridData(SWT.FILL, SWT.FILL, true, true);
label.setLayoutData(gridData);
this.columns.add(new Column(columnDef, gridData));
}
this.addAction = widgetFactory.imageButton(
ImageIcon.ADD_BOX,
this,
new LocTextKey(locTextKeyPrefix + "addAction"),
this::addRow);
final GridData gridData = new GridData(SWT.CENTER, SWT.FILL, true, true);
gridData.widthHint = ACTION_COLUMN_WIDTH;
this.addAction.setLayoutData(gridData);
this.rows = new ArrayList<>();
this.addListener(SWT.Resize, this::adaptColumnWidth);
}
public void setListener(final Listener listener) {
this.listener = listener;
}
void addRow(final Event event) {
final List<ControlAdapter> row = new ArrayList<>();
for (final Column column : this.columns) {
row.add(createCell(column, column.columnDef.defaultValue));
}
this.rows.add(new Row(row));
this.adaptLayout();
if (this.listener != null) {
this.listener.handleEvent(new Event());
}
}
public void adaptLayout() {
this.getParent().getParent().layout(true, true);
PageService.updateScrolledComposite(this);
}
void addRow(final String values) {
if (StringUtils.isBlank(values)) {
return;
}
final Map<String, String> nameValueMap = new HashMap<>();
for (final String valueMap : StringUtils.split(values, Constants.EMBEDDED_LIST_SEPARATOR)) {
final String[] nameValue = StringUtils.split(valueMap, Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR);
if (nameValue.length > 1) {
nameValueMap.put(nameValue[0], nameValue[1]);
} else {
nameValueMap.put(nameValue[0], null);
}
}
final List<ControlAdapter> row = new ArrayList<>();
for (final Column column : this.columns) {
row.add(createCell(column, nameValueMap.get(column.columnDef.name)));
}
this.rows.add(new Row(row));
}
void deleteRow(final Row row) {
if (this.rows.remove(row)) {
row.dispose();
}
this.adaptLayout();
}
public String getValue() {
return StringUtils.join(
this.rows
.stream()
.map(Row::getValue)
.collect(Collectors.toList()),
Constants.LIST_SEPARATOR);
}
public void setValue(final String value) {
clearTable();
if (StringUtils.isBlank(value)) {
return;
}
for (final String val : StringUtils.split(value, Constants.LIST_SEPARATOR)) {
addRow(val);
}
this.adaptLayout();
}
private ControlAdapter createCell(final Column column, final String value) {
switch (column.columnDef.type) {
case CHECKBOX: {
final CheckBox checkBox = new CheckBox(this, column.columnDef, this.listener);
checkBox.setValue(value);
return checkBox;
}
case TEXT_FIELD: {
final TextField textField = new TextField(this, column.columnDef, this.listener);
textField.setValue(value);
return textField;
}
default: {
return new Dummy(this, column.columnDef);
}
}
}
private void clearTable() {
for (final Row row : this.rows) {
row.dispose();
}
this.rows.clear();
}
private void adaptColumnWidth(final Event event) {
try {
final int currentTableWidth = super.getClientArea().width - ACTION_COLUMN_WIDTH;
final int widthUnit = currentTableWidth / this.columns
.stream()
.reduce(0,
(i, c2) -> i + c2.columnDef.widthFactor,
Integer::sum);
this.columns
.forEach(c -> c.header.widthHint = c.columnDef.widthFactor * widthUnit);
super.layout(true, true);
} catch (final Exception e) {
log.warn("Failed to adaptColumnWidth: ", e);
}
}
final class Row {
final List<ControlAdapter> cells;
final Label removeAction;
protected Row(final List<ControlAdapter> cells) {
this.cells = cells;
this.removeAction = GridTable.this.widgetFactory.imageButton(
ImageIcon.REMOVE_BOX,
GridTable.this,
new LocTextKey(GridTable.this.locTextKeyPrefix + "removeAction"),
event -> deleteRow(this));
final GridData gridData = new GridData(SWT.CENTER, SWT.CENTER, true, true);
gridData.widthHint = ACTION_COLUMN_WIDTH;
this.removeAction.setLayoutData(gridData);
}
void dispose() {
for (final ControlAdapter cell : this.cells) {
cell.dispose();
}
this.removeAction.dispose();
}
String getValue() {
return StringUtils.join(
this.cells
.stream()
.map(cell -> cell.columnDef().name + Constants.FORM_URL_ENCODED_NAME_VALUE_SEPARATOR
+ cell.getValue())
.collect(Collectors.toList()),
Constants.EMBEDDED_LIST_SEPARATOR);
}
}
public static final class ColumnDef {
final int widthFactor;
final String name;
final AttributeType type;
final String defaultValue;
protected ColumnDef(
final int widthFactor,
final String name,
final AttributeType type,
final String defaultValue) {
this.widthFactor = widthFactor;
this.name = name;
this.type = type;
this.defaultValue = defaultValue;
}
public static ColumnDef fromString(
final String string,
final Map<String, String> defaultValueMap) {
if (StringUtils.isBlank(string)) {
return null;
}
final String[] split = StringUtils.split(string, Constants.COMPLEX_VALUE_SEPARATOR);
final AttributeType attributeType = AttributeType.valueOf(split[2]);
if (!SUPPORTED_TYPES.contains(attributeType)) {
throw new UnsupportedOperationException(
"The AttributeType : " + attributeType + " is not supported yet");
}
return new ColumnDef(
Integer.parseInt(split[0]),
split[1],
attributeType,
defaultValueMap.get(split[1]));
}
}
private static class Column {
final ColumnDef columnDef;
final GridData header;
protected Column(final ColumnDef columnDef, final GridData header) {
this.columnDef = columnDef;
this.header = header;
}
}
interface ControlAdapter {
String getValue();
void setValue(String value);
void dispose();
ColumnDef columnDef();
}
private static class Dummy implements ControlAdapter {
private final Label label;
private final ColumnDef columnDef;
Dummy(final Composite parent, final ColumnDef columnDef) {
this.label = new Label(parent, SWT.NONE);
this.label.setText("unsupported");
this.columnDef = columnDef;
}
@Override
public String getValue() {
return null;
}
@Override
public void setValue(final String value) {
}
@Override
public void dispose() {
this.label.dispose();
}
@Override
public ColumnDef columnDef() {
return this.columnDef;
}
}
private static class CheckBox implements ControlAdapter {
private final Button checkboxButton;
private final ColumnDef columnDef;
CheckBox(final Composite parent, final ColumnDef columnDef, final Listener listener) {
this.checkboxButton = new Button(parent, SWT.CHECK);
this.checkboxButton.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
this.columnDef = columnDef;
if (listener != null) {
this.checkboxButton.addListener(SWT.Selection, listener);
}
}
@Override
public String getValue() {
return this.checkboxButton.getSelection()
? Constants.TRUE_STRING
: Constants.FALSE_STRING;
}
@Override
public void setValue(final String value) {
this.checkboxButton.setSelection(BooleanUtils.toBoolean(value));
}
@Override
public void dispose() {
this.checkboxButton.dispose();
}
@Override
public ColumnDef columnDef() {
return this.columnDef;
}
}
private static class TextField implements ControlAdapter {
private final Text _textField;
private final ColumnDef columnDef;
TextField(final Composite parent, final ColumnDef columnDef, final Listener listener) {
this._textField = new Text(parent, SWT.LEFT | SWT.BORDER);
this._textField.setData(RWT.CUSTOM_VARIANT, CustomVariant.CONFIG_INPUT_READONLY.key);
this._textField.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
this.columnDef = columnDef;
this._textField.addListener(SWT.FocusOut, listener);
this._textField.addListener(SWT.Traverse, listener);
}
@Override
public String getValue() {
return this._textField.getText();
}
@Override
public void setValue(final String value) {
this._textField.setText((value != null) ? value : "");
}
@Override
public void dispose() {
this._textField.dispose();
}
@Override
public ColumnDef columnDef() {
return this.columnDef;
}
}
}

435
src/main/java/ch/ethz/seb/sebserver/gui/widget/ImageUploadSelection.java
View file

@ -1,222 +1,213 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Base64;
import java.util.Collections;
import java.util.HashSet;
import java.util.Locale;
import java.util.Set;
import java.util.function.Consumer;
import org.apache.commons.codec.binary.Base64InputStream;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.fileupload.FileDetails;
import org.eclipse.rap.fileupload.FileUploadHandler;
import org.eclipse.rap.fileupload.FileUploadReceiver;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.widgets.FileUpload;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.ImageData;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.push.ServerPushContext;
import ch.ethz.seb.sebserver.gui.service.push.ServerPushService;
public final class ImageUploadSelection extends Composite {
private static final long serialVersionUID = 368264811155804533L;
private static final Logger log = LoggerFactory.getLogger(ImageUploadSelection.class);
public static final Set<String> SUPPORTED_IMAGE_FILES = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
".png",
".jpg",
".jpeg")));
private final ServerPushService serverPushService;
private final Composite imageCanvas;
private final FileUpload fileUpload;
private final int maxWidth;
private final int maxHeight;
private Consumer<String> errorHandler;
private String imageBase64 = null;
private boolean loadNewImage = false;
private boolean imageLoaded = false;
ImageUploadSelection(
final Composite parent,
final ServerPushService serverPushService,
final I18nSupport i18nSupport,
final boolean readonly,
final int maxWidth,
final int maxHeight) {
super(parent, SWT.NONE);
final GridLayout gridLayout = new GridLayout(1, false);
gridLayout.horizontalSpacing = 0;
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
gridLayout.marginLeft = 0;
gridLayout.verticalSpacing = 0;
super.setLayout(gridLayout);
this.serverPushService = serverPushService;
this.maxWidth = maxWidth;
this.maxHeight = maxHeight;
if (!readonly) {
this.fileUpload = new FileUpload(this, SWT.NONE);
this.fileUpload.setImage(WidgetFactory.ImageIcon.IMPORT.getImage(parent.getDisplay()));
final GridData gridData = new GridData(SWT.LEFT, SWT.TOP, false, false);
gridData.horizontalIndent = 0;
this.fileUpload.setLayoutData(gridData);
final FileUploadHandler uploadHandler = new FileUploadHandler(new ImageReceiver());
this.fileUpload.addListener(SWT.Selection, event -> {
final String fileName = ImageUploadSelection.this.fileUpload.getFileName();
if (fileName == null || !fileSupported(fileName)) {
if (ImageUploadSelection.this.errorHandler != null) {
final String text = i18nSupport.getText(
"sebserver.institution.form.logoImage.unsupportedFileType",
"Unsupported image file type selected");
ImageUploadSelection.this.errorHandler.accept(text);
}
log.warn("Unsupported image file selected: {}", fileName);
return;
}
ImageUploadSelection.this.loadNewImage = true;
ImageUploadSelection.this.imageLoaded = false;
ImageUploadSelection.this.fileUpload.submit(uploadHandler.getUploadUrl());
ImageUploadSelection.this.serverPushService.runServerPush(
new ServerPushContext(ImageUploadSelection.this, ImageUploadSelection::uploadInProgress),
200,
ImageUploadSelection::update);
});
} else {
this.fileUpload = null;
}
this.imageCanvas = new Composite(this, SWT.NONE);
final GridData canvas = new GridData(SWT.FILL, SWT.FILL, true, true);
this.imageCanvas.setLayoutData(canvas);
}
public void setErrorHandler(final Consumer<String> errorHandler) {
this.errorHandler = errorHandler;
}
public void setSelectionText(final String text) {
if (this.fileUpload != null) {
this.fileUpload.setToolTipText(Utils.formatLineBreaks(text));
}
}
public String getImageBase64() {
return this.imageBase64;
}
public void setImageBase64(final String imageBase64) {
if (StringUtils.isBlank(imageBase64)) {
return;
}
this.imageBase64 = imageBase64;
final Base64InputStream input = new Base64InputStream(
new ByteArrayInputStream(imageBase64.getBytes(StandardCharsets.UTF_8)), false);
setImage(this, input);
}
private static final boolean uploadInProgress(final ServerPushContext context) {
final ImageUploadSelection imageUpload = (ImageUploadSelection) context.getAnchor();
return imageUpload.loadNewImage && !imageUpload.imageLoaded;
}
private static final void update(final ServerPushContext context) {
final ImageUploadSelection imageUpload = (ImageUploadSelection) context.getAnchor();
if (imageUpload.imageBase64 != null
&& imageUpload.loadNewImage
&& imageUpload.imageLoaded) {
final Base64InputStream input = new Base64InputStream(
new ByteArrayInputStream(
imageUpload.imageBase64.getBytes(StandardCharsets.UTF_8)),
false);
setImage(imageUpload, input);
context.layout();
imageUpload.layout();
imageUpload.loadNewImage = false;
imageUpload.errorHandler.accept(null);
}
}
private static void setImage(final ImageUploadSelection imageUpload, final Base64InputStream input) {
imageUpload.imageCanvas.setData(RWT.CUSTOM_VARIANT, "bgLogoNoImage");
final Image image = new Image(imageUpload.imageCanvas.getDisplay(), input);
final Rectangle imageBounds = image.getBounds();
final int width = (imageBounds.width > imageUpload.maxWidth)
? imageUpload.maxWidth
: imageBounds.width;
final int height = (imageBounds.height > imageUpload.maxHeight)
? imageUpload.maxHeight
: imageBounds.height;
final ImageData imageData = image.getImageData().scaledTo(width, height);
imageUpload.imageCanvas.setBackgroundImage(new Image(imageUpload.imageCanvas.getDisplay(), imageData));
}
private static boolean fileSupported(final String fileName) {
return SUPPORTED_IMAGE_FILES
.stream()
.filter(fileType -> fileName.toUpperCase(Locale.ROOT)
.endsWith(fileType.toUpperCase(Locale.ROOT)))
.findFirst()
.isPresent();
}
private final class ImageReceiver extends FileUploadReceiver {
@Override
public void receive(final InputStream stream, final FileDetails details) throws IOException {
try {
final String contentType = details.getContentType();
if (contentType != null && contentType.startsWith("image")) {
ImageUploadSelection.this.imageBase64 = Base64.getEncoder()
.encodeToString(IOUtils.toByteArray(stream));
}
} catch (final Exception e) {
log.error("Error while trying to upload image", e);
} finally {
ImageUploadSelection.this.imageLoaded = true;
stream.close();
}
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Base64;
import java.util.Collections;
import java.util.HashSet;
import java.util.Locale;
import java.util.Set;
import java.util.function.Consumer;
import org.apache.commons.codec.binary.Base64InputStream;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.fileupload.FileDetails;
import org.eclipse.rap.fileupload.FileUploadHandler;
import org.eclipse.rap.fileupload.FileUploadReceiver;
import org.eclipse.rap.rwt.RWT;
import org.eclipse.rap.rwt.widgets.FileUpload;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.ImageData;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.i18n.I18nSupport;
import ch.ethz.seb.sebserver.gui.service.push.ServerPushContext;
import ch.ethz.seb.sebserver.gui.service.push.ServerPushService;
public final class ImageUploadSelection extends Composite {
private static final long serialVersionUID = 368264811155804533L;
private static final Logger log = LoggerFactory.getLogger(ImageUploadSelection.class);
public static final Set<String> SUPPORTED_IMAGE_FILES = Set.of(".png", ".jpg", ".jpeg");
private final ServerPushService serverPushService;
private final Composite imageCanvas;
private final FileUpload fileUpload;
private final int maxWidth;
private final int maxHeight;
private Consumer<String> errorHandler;
private String imageBase64 = null;
private boolean loadNewImage = false;
private boolean imageLoaded = false;
ImageUploadSelection(
final Composite parent,
final ServerPushService serverPushService,
final I18nSupport i18nSupport,
final boolean readonly,
final int maxWidth,
final int maxHeight) {
super(parent, SWT.NONE);
final GridLayout gridLayout = new GridLayout(1, false);
gridLayout.horizontalSpacing = 0;
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
gridLayout.marginLeft = 0;
gridLayout.verticalSpacing = 0;
super.setLayout(gridLayout);
this.serverPushService = serverPushService;
this.maxWidth = maxWidth;
this.maxHeight = maxHeight;
if (!readonly) {
this.fileUpload = new FileUpload(this, SWT.NONE);
this.fileUpload.setImage(WidgetFactory.ImageIcon.IMPORT.getImage(parent.getDisplay()));
final GridData gridData = new GridData(SWT.LEFT, SWT.TOP, false, false);
gridData.horizontalIndent = 0;
this.fileUpload.setLayoutData(gridData);
final FileUploadHandler uploadHandler = new FileUploadHandler(new ImageReceiver());
this.fileUpload.addListener(SWT.Selection, event -> {
final String fileName = ImageUploadSelection.this.fileUpload.getFileName();
if (fileName == null || !fileSupported(fileName)) {
if (ImageUploadSelection.this.errorHandler != null) {
final String text = i18nSupport.getText(
"sebserver.institution.form.logoImage.unsupportedFileType",
"Unsupported image file type selected");
ImageUploadSelection.this.errorHandler.accept(text);
}
log.warn("Unsupported image file selected: {}", fileName);
return;
}
ImageUploadSelection.this.loadNewImage = true;
ImageUploadSelection.this.imageLoaded = false;
ImageUploadSelection.this.fileUpload.submit(uploadHandler.getUploadUrl());
ImageUploadSelection.this.serverPushService.runServerPush(
new ServerPushContext(ImageUploadSelection.this, ImageUploadSelection::uploadInProgress),
200,
ImageUploadSelection::update);
});
} else {
this.fileUpload = null;
}
this.imageCanvas = new Composite(this, SWT.NONE);
final GridData canvas = new GridData(SWT.FILL, SWT.FILL, true, true);
this.imageCanvas.setLayoutData(canvas);
}
public void setErrorHandler(final Consumer<String> errorHandler) {
this.errorHandler = errorHandler;
}
public void setSelectionText(final String text) {
if (this.fileUpload != null) {
this.fileUpload.setToolTipText(Utils.formatLineBreaks(text));
}
}
public String getImageBase64() {
return this.imageBase64;
}
public void setImageBase64(final String imageBase64) {
if (StringUtils.isBlank(imageBase64)) {
return;
}
this.imageBase64 = imageBase64;
final Base64InputStream input = new Base64InputStream(
new ByteArrayInputStream(imageBase64.getBytes(StandardCharsets.UTF_8)), false);
setImage(this, input);
}
private static boolean uploadInProgress(final ServerPushContext context) {
final ImageUploadSelection imageUpload = (ImageUploadSelection) context.getAnchor();
return imageUpload.loadNewImage && !imageUpload.imageLoaded;
}
private static void update(final ServerPushContext context) {
final ImageUploadSelection imageUpload = (ImageUploadSelection) context.getAnchor();
if (imageUpload.imageBase64 != null
&& imageUpload.loadNewImage
&& imageUpload.imageLoaded) {
final Base64InputStream input = new Base64InputStream(
new ByteArrayInputStream(
imageUpload.imageBase64.getBytes(StandardCharsets.UTF_8)),
false);
setImage(imageUpload, input);
context.layout();
imageUpload.layout();
imageUpload.loadNewImage = false;
imageUpload.errorHandler.accept(null);
}
}
private static void setImage(final ImageUploadSelection imageUpload, final Base64InputStream input) {
imageUpload.imageCanvas.setData(RWT.CUSTOM_VARIANT, "bgLogoNoImage");
final Image image = new Image(imageUpload.imageCanvas.getDisplay(), input);
final Rectangle imageBounds = image.getBounds();
final int width = Math.min(imageBounds.width, imageUpload.maxWidth);
final int height = Math.min(imageBounds.height, imageUpload.maxHeight);
final ImageData imageData = image.getImageData().scaledTo(width, height);
imageUpload.imageCanvas.setBackgroundImage(new Image(imageUpload.imageCanvas.getDisplay(), imageData));
}
private static boolean fileSupported(final String fileName) {
return SUPPORTED_IMAGE_FILES
.stream()
.anyMatch(fileType -> fileName.toUpperCase(Locale.ROOT)
.endsWith(fileType.toUpperCase(Locale.ROOT)));
}
private final class ImageReceiver extends FileUploadReceiver {
@Override
public void receive(final InputStream stream, final FileDetails details) throws IOException {
try {
final String contentType = details.getContentType();
if (contentType != null && contentType.startsWith("image")) {
ImageUploadSelection.this.imageBase64 = Base64.getEncoder()
.encodeToString(IOUtils.toByteArray(stream));
}
} catch (final Exception e) {
log.error("Error while trying to upload image", e);
} finally {
ImageUploadSelection.this.imageLoaded = true;
stream.close();
}
}
}
}

22
src/main/java/ch/ethz/seb/sebserver/gui/widget/MultiSelectionCheckbox.java
View file

@ -8,12 +8,11 @@
package ch.ethz.seb.sebserver.gui.widget;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.util.Tuple;
import ch.ethz.seb.sebserver.gbl.util.Tuple3;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
@ -22,11 +21,10 @@ import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Listener;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.util.Tuple;
import ch.ethz.seb.sebserver.gbl.util.Tuple3;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
public final class MultiSelectionCheckbox extends Composite implements Selection {
@ -121,7 +119,7 @@ public final class MultiSelectionCheckbox extends Composite implements Selection
.stream()
.filter(Button::getSelection)
.map(button -> (String) button.getData(OPTION_VALUE))
.collect(Collectors.toList()).toArray());
.toArray());
}
@Override

482
src/main/java/ch/ethz/seb/sebserver/gui/widget/MultiSelectionCombo.java
View file

@ -1,252 +1,230 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.rwt.widgets.DropDown;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Text;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.util.Tuple;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
public final class MultiSelectionCombo extends Composite implements Selection {
private static final Logger log = LoggerFactory.getLogger(MultiSelectionCombo.class);
private static final long serialVersionUID = -7787134114963647332L;
private final WidgetFactory widgetFactory;
private final List<Control> selectionControls = new ArrayList<>();
private final List<Tuple<String>> valueMapping = new ArrayList<>();
private final List<Tuple<String>> availableValues = new ArrayList<>();
private final List<Tuple<String>> selectedValues = new ArrayList<>();
private final DropDown dropDown;
private final Text textInput;
private final GridData textCell;
private final Composite updateAnchor;
private Listener listener = null;
MultiSelectionCombo(
final Composite parent,
final WidgetFactory widgetFactory,
final String locTextPrefix,
final Composite updateAnchor) {
super(parent, SWT.NONE);
this.widgetFactory = widgetFactory;
final GridLayout gridLayout = new GridLayout();
gridLayout.verticalSpacing = 1;
gridLayout.marginLeft = 0;
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
gridLayout.horizontalSpacing = 0;
setLayout(gridLayout);
this.addListener(SWT.Resize, this::adaptColumnWidth);
this.textInput = widgetFactory.textInput(this);
this.textCell = new GridData(SWT.LEFT, SWT.CENTER, true, true);
this.textInput.setLayoutData(this.textCell);
this.dropDown = new DropDown(this.textInput, SWT.NONE);
this.textInput.addListener(SWT.FocusIn, event -> {
openDropDown();
});
this.textInput.addListener(SWT.Modify, event -> {
openDropDown();
});
this.dropDown.addListener(SWT.Selection, event -> {
final int selectionIndex = this.dropDown.getSelectionIndex();
if (selectionIndex >= 0) {
final String selectedItem = this.dropDown.getItems()[selectionIndex];
addSelection(itemForName(selectedItem));
}
});
this.updateAnchor = updateAnchor;
}
private void openDropDown() {
final String text = this.textInput.getText();
if (text == null) {
this.dropDown.setVisible(false);
return;
}
final Collection<String> items = this.availableValues
.stream()
.filter(it -> it._2 != null && it._2.startsWith(text))
.map(t -> t._2)
.collect(Collectors.toList());
this.dropDown.setItems(items.toArray(new String[items.size()]));
this.dropDown.setSelectionIndex(0);
this.dropDown.setVisible(true);
}
@Override
public Type type() {
return Type.MULTI_COMBO;
}
@Override
public void setSelectionListener(final Listener listener) {
this.listener = listener;
}
@Override
public void applyNewMapping(final List<Tuple<String>> mapping) {
this.valueMapping.clear();
this.valueMapping.addAll(mapping);
this.clear();
}
@Override
public void select(final String keys) {
clear();
if (StringUtils.isBlank(keys)) {
return;
}
Arrays.asList(StringUtils.split(keys, Constants.LIST_SEPARATOR))
.stream()
.map(this::itemForId)
.forEach(this::addSelection);
}
@Override
public String getSelectionValue() {
if (this.selectedValues.isEmpty()) {
return null;
}
return this.selectedValues
.stream()
.map(t -> t._1)
.reduce("", (s1, s2) -> {
if (!StringUtils.isBlank(s1)) {
return s1.concat(Constants.LIST_SEPARATOR).concat(s2);
} else {
return s1.concat(s2);
}
});
}
@Override
public void clear() {
this.selectedValues.clear();
this.selectionControls
.stream()
.forEach(Control::dispose);
this.selectionControls.clear();
this.availableValues.clear();
this.availableValues.addAll(this.valueMapping);
}
private void addSelection(final Tuple<String> item) {
if (item == null) {
return;
}
this.selectedValues.add(item);
final Label label = this.widgetFactory.label(this, item._2);
label.setData(OPTION_VALUE, item._2);
final GridData textCell = new GridData(SWT.LEFT, SWT.CENTER, true, true);
label.setLayoutData(textCell);
label.addListener(SWT.MouseDoubleClick, event -> {
removeComboSelection(event);
});
this.selectionControls.add(label);
this.availableValues.remove(item);
PageService.updateScrolledComposite(this);
this.updateAnchor.layout(true, true);
}
private void removeComboSelection(final Event event) {
if (event.widget == null) {
return;
}
final String selectionKey = (String) event.widget.getData(OPTION_VALUE);
final Optional<Control> findFirst = this.selectionControls.stream()
.filter(t -> selectionKey.equals(t.getData(OPTION_VALUE)))
.findFirst();
if (!findFirst.isPresent()) {
return;
}
final Control control = findFirst.get();
final int indexOf = this.selectionControls.indexOf(control);
this.selectionControls.remove(control);
control.dispose();
final Tuple<String> value = this.selectedValues.remove(indexOf);
this.availableValues.add(value);
PageService.updateScrolledComposite(this);
this.updateAnchor.layout(true, true);
if (this.listener != null) {
this.listener.handleEvent(event);
}
}
private void adaptColumnWidth(final Event event) {
try {
final int currentTableWidth = this.getClientArea().width;
this.textCell.widthHint = currentTableWidth;
this.layout();
} catch (final Exception e) {
log.warn("Failed to adaptColumnWidth: ", e);
}
}
private Tuple<String> itemForName(final String name) {
final Optional<Tuple<String>> findFirst = this.availableValues
.stream()
.filter(it -> it._2 != null && it._2.equals(name))
.findFirst();
if (findFirst.isPresent()) {
return findFirst.get();
}
return null;
}
private Tuple<String> itemForId(final String id) {
final Optional<Tuple<String>> findFirst = this.availableValues
.stream()
.filter(it -> it._1 != null && it._1.equals(id))
.findFirst();
if (findFirst.isPresent()) {
return findFirst.get();
}
return null;
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.util.Tuple;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.rap.rwt.widgets.DropDown;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Text;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;
public final class MultiSelectionCombo extends Composite implements Selection {
private static final Logger log = LoggerFactory.getLogger(MultiSelectionCombo.class);
private static final long serialVersionUID = -7787134114963647332L;
private final WidgetFactory widgetFactory;
private final List<Control> selectionControls = new ArrayList<>();
private final List<Tuple<String>> valueMapping = new ArrayList<>();
private final List<Tuple<String>> availableValues = new ArrayList<>();
private final List<Tuple<String>> selectedValues = new ArrayList<>();
private final DropDown dropDown;
private final Text textInput;
private final GridData textCell;
private final Composite updateAnchor;
private Listener listener = null;
MultiSelectionCombo(
final Composite parent,
final WidgetFactory widgetFactory,
final String locTextPrefix,
final Composite updateAnchor) {
super(parent, SWT.NONE);
this.widgetFactory = widgetFactory;
final GridLayout gridLayout = new GridLayout();
gridLayout.verticalSpacing = 1;
gridLayout.marginLeft = 0;
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
gridLayout.horizontalSpacing = 0;
setLayout(gridLayout);
this.addListener(SWT.Resize, this::adaptColumnWidth);
this.textInput = widgetFactory.textInput(this);
this.textCell = new GridData(SWT.LEFT, SWT.CENTER, true, true);
this.textInput.setLayoutData(this.textCell);
this.dropDown = new DropDown(this.textInput, SWT.NONE);
this.textInput.addListener(SWT.FocusIn, event -> openDropDown());
this.textInput.addListener(SWT.Modify, event -> openDropDown());
this.dropDown.addListener(SWT.Selection, event -> {
final int selectionIndex = this.dropDown.getSelectionIndex();
if (selectionIndex >= 0) {
final String selectedItem = this.dropDown.getItems()[selectionIndex];
addSelection(itemForName(selectedItem));
}
});
this.updateAnchor = updateAnchor;
}
private void openDropDown() {
final String text = this.textInput.getText();
if (text == null) {
this.dropDown.setVisible(false);
return;
}
this.dropDown.setItems(this.availableValues
.stream()
.filter(it -> it._2 != null && it._2.startsWith(text))
.map(t -> t._2).toArray(String[]::new));
this.dropDown.setSelectionIndex(0);
this.dropDown.setVisible(true);
}
@Override
public Type type() {
return Type.MULTI_COMBO;
}
@Override
public void setSelectionListener(final Listener listener) {
this.listener = listener;
}
@Override
public void applyNewMapping(final List<Tuple<String>> mapping) {
this.valueMapping.clear();
this.valueMapping.addAll(mapping);
this.clear();
}
@Override
public void select(final String keys) {
clear();
if (StringUtils.isBlank(keys)) {
return;
}
Arrays.stream(StringUtils.split(keys, Constants.LIST_SEPARATOR))
.map(this::itemForId)
.forEach(this::addSelection);
}
@Override
public String getSelectionValue() {
if (this.selectedValues.isEmpty()) {
return null;
}
return this.selectedValues
.stream()
.map(t -> t._1)
.reduce("", (s1, s2) -> {
if (!StringUtils.isBlank(s1)) {
return s1.concat(Constants.LIST_SEPARATOR).concat(s2);
} else {
return s1.concat(s2);
}
});
}
@Override
public void clear() {
this.selectedValues.clear();
this.selectionControls
.forEach(Control::dispose);
this.selectionControls.clear();
this.availableValues.clear();
this.availableValues.addAll(this.valueMapping);
}
private void addSelection(final Tuple<String> item) {
if (item == null) {
return;
}
this.selectedValues.add(item);
final Label label = this.widgetFactory.label(this, item._2);
label.setData(OPTION_VALUE, item._2);
final GridData textCell = new GridData(SWT.LEFT, SWT.CENTER, true, true);
label.setLayoutData(textCell);
label.addListener(SWT.MouseDoubleClick, this::removeComboSelection);
this.selectionControls.add(label);
this.availableValues.remove(item);
PageService.updateScrolledComposite(this);
this.updateAnchor.layout(true, true);
}
private void removeComboSelection(final Event event) {
if (event.widget == null) {
return;
}
final String selectionKey = (String) event.widget.getData(OPTION_VALUE);
final Optional<Control> findFirst = this.selectionControls.stream()
.filter(t -> selectionKey.equals(t.getData(OPTION_VALUE)))
.findFirst();
if (!findFirst.isPresent()) {
return;
}
final Control control = findFirst.get();
final int indexOf = this.selectionControls.indexOf(control);
this.selectionControls.remove(control);
control.dispose();
final Tuple<String> value = this.selectedValues.remove(indexOf);
this.availableValues.add(value);
PageService.updateScrolledComposite(this);
this.updateAnchor.layout(true, true);
if (this.listener != null) {
this.listener.handleEvent(event);
}
}
private void adaptColumnWidth(final Event event) {
try {
this.textCell.widthHint = this.getClientArea().width;
this.layout();
} catch (final Exception e) {
log.warn("Failed to adaptColumnWidth: ", e);
}
}
private Tuple<String> itemForName(final String name) {
final Optional<Tuple<String>> findFirst = this.availableValues
.stream()
.filter(it -> it._2 != null && it._2.equals(name))
.findFirst();
return findFirst.orElse(null);
}
private Tuple<String> itemForId(final String id) {
final Optional<Tuple<String>> findFirst = this.availableValues
.stream()
.filter(it -> it._1 != null && it._1.equals(id))
.findFirst();
return findFirst.orElse(null);
}
}

243
src/main/java/ch/ethz/seb/sebserver/gui/widget/RadioSelection.java
View file

@ -1,122 +1,121 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Listener;
import ch.ethz.seb.sebserver.gbl.util.Tuple;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
public final class RadioSelection extends Composite implements Selection {
private static final long serialVersionUID = 7937242481193100852L;
private Listener listener = null;
private final Map<String, Button> radioButtons;
RadioSelection(final Composite parent) {
super(parent, SWT.NONE);
final GridLayout gridLayout = new GridLayout(1, true);
gridLayout.verticalSpacing = 1;
gridLayout.marginLeft = 0;
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
setLayout(gridLayout);
this.radioButtons = new LinkedHashMap<>();
}
@Override
public Type type() {
return Type.RADIO;
}
@Override
public void applyNewMapping(final List<Tuple<String>> mapping) {
final String selectionValue = getSelectionValue();
this.radioButtons.clear();
PageService.clearComposite(this);
for (final Tuple<String> tuple : mapping) {
final Button button = new Button(this, SWT.RADIO);
button.setText(tuple._2);
final GridData gridData = new GridData(SWT.FILL, SWT.CENTER, true, true);
button.setLayoutData(gridData);
button.setData(OPTION_VALUE, tuple._1);
button.addListener(SWT.Selection, event -> {
if (this.listener != null) {
this.listener.handleEvent(event);
}
});
this.radioButtons.put(tuple._1, button);
}
if (StringUtils.isNotBlank(selectionValue)) {
select(selectionValue);
}
}
@Override
public void applyToolTipsForItems(final List<Tuple<String>> mapping) {
mapping
.stream()
.filter(tuple -> StringUtils.isNotBlank(tuple._2))
.forEach(tuple -> {
final Button button = this.radioButtons.get(tuple._1);
if (button != null) {
button.setToolTipText(Utils.formatLineBreaks(tuple._2));
}
});
}
@Override
public void select(final String key) {
clear();
if (StringUtils.isNotBlank(key) && this.radioButtons.containsKey(key)) {
this.radioButtons.get(key).setSelection(true);
}
}
@Override
public String getSelectionValue() {
return this.radioButtons
.values()
.stream()
.filter(button -> button.getSelection())
.findFirst()
.map(button -> (String) button.getData(OPTION_VALUE))
.orElse(null);
}
@Override
public void clear() {
this.radioButtons
.values()
.stream()
.forEach(button -> button.setSelection(false));
}
@Override
public void setSelectionListener(final Listener listener) {
this.listener = listener;
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Listener;
import ch.ethz.seb.sebserver.gbl.util.Tuple;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.gui.service.page.PageService;
public final class RadioSelection extends Composite implements Selection {
private static final long serialVersionUID = 7937242481193100852L;
private Listener listener = null;
private final Map<String, Button> radioButtons;
RadioSelection(final Composite parent) {
super(parent, SWT.NONE);
final GridLayout gridLayout = new GridLayout(1, true);
gridLayout.verticalSpacing = 1;
gridLayout.marginLeft = 0;
gridLayout.marginHeight = 0;
gridLayout.marginWidth = 0;
setLayout(gridLayout);
this.radioButtons = new LinkedHashMap<>();
}
@Override
public Type type() {
return Type.RADIO;
}
@Override
public void applyNewMapping(final List<Tuple<String>> mapping) {
final String selectionValue = getSelectionValue();
this.radioButtons.clear();
PageService.clearComposite(this);
for (final Tuple<String> tuple : mapping) {
final Button button = new Button(this, SWT.RADIO);
button.setText(tuple._2);
final GridData gridData = new GridData(SWT.FILL, SWT.CENTER, true, true);
button.setLayoutData(gridData);
button.setData(OPTION_VALUE, tuple._1);
button.addListener(SWT.Selection, event -> {
if (this.listener != null) {
this.listener.handleEvent(event);
}
});
this.radioButtons.put(tuple._1, button);
}
if (StringUtils.isNotBlank(selectionValue)) {
select(selectionValue);
}
}
@Override
public void applyToolTipsForItems(final List<Tuple<String>> mapping) {
mapping
.stream()
.filter(tuple -> StringUtils.isNotBlank(tuple._2))
.forEach(tuple -> {
final Button button = this.radioButtons.get(tuple._1);
if (button != null) {
button.setToolTipText(Utils.formatLineBreaks(tuple._2));
}
});
}
@Override
public void select(final String key) {
clear();
if (StringUtils.isNotBlank(key) && this.radioButtons.containsKey(key)) {
this.radioButtons.get(key).setSelection(true);
}
}
@Override
public String getSelectionValue() {
return this.radioButtons
.values()
.stream()
.filter(Button::getSelection)
.findFirst()
.map(button -> (String) button.getData(OPTION_VALUE))
.orElse(null);
}
@Override
public void clear() {
this.radioButtons
.values()
.forEach(button -> button.setSelection(false));
}
@Override
public void setSelectionListener(final Listener listener) {
this.listener = listener;
}
}

130
src/main/java/ch/ethz/seb/sebserver/gui/widget/Selection.java
View file

@ -1,65 +1,65 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.util.List;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Listener;
import ch.ethz.seb.sebserver.gbl.util.Tuple;
public interface Selection {
static final String OPTION_VALUE = "OPTION_VALUE";
enum Type {
SINGLE,
SINGLE_COMBO,
RADIO,
MULTI,
MULTI_COMBO,
MULTI_CHECKBOX,
COLOR,
}
Type type();
void applyNewMapping(final List<Tuple<String>> mapping);
void select(final String keys);
String getSelectionValue();
default String getSelectionReadableValue() {
return getSelectionValue();
}
void clear();
void setVisible(boolean visible);
void setSelectionListener(Listener listener);
void setToolTipText(String tooltipText);
default void applyToolTipsForItems(final List<Tuple<String>> mapping) {
throw new UnsupportedOperationException("Must be implemented for this specific Selection");
}
default Control adaptToControl() {
return (Control) this;
}
@SuppressWarnings("unchecked")
default <T extends Selection> T getTypeInstance() {
return (T) this;
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.gui.widget;
import java.util.List;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Listener;
import ch.ethz.seb.sebserver.gbl.util.Tuple;
public interface Selection {
String OPTION_VALUE = "OPTION_VALUE";
enum Type {
SINGLE,
SINGLE_COMBO,
RADIO,
MULTI,
MULTI_COMBO,
MULTI_CHECKBOX,
COLOR,
}
Type type();
void applyNewMapping(final List<Tuple<String>> mapping);
void select(final String keys);
String getSelectionValue();
default String getSelectionReadableValue() {
return getSelectionValue();
}
void clear();
void setVisible(boolean visible);
void setSelectionListener(Listener listener);
void setToolTipText(String tooltipText);
default void applyToolTipsForItems(final List<Tuple<String>> mapping) {
throw new UnsupportedOperationException("Must be implemented for this specific Selection");
}
default Control adaptToControl() {
return (Control) this;
}
@SuppressWarnings("unchecked")
default <T extends Selection> T getTypeInstance() {
return (T) this;
}
}

2
src/main/java/ch/ethz/seb/sebserver/gui/widget/SingleSelection.java
View file

@ -87,7 +87,7 @@ public final class SingleSelection extends Combo implements Selection {
@Override
public void clear() {
super.clearSelection();
super.setItems(this.valueMapping.toArray(new String[this.valueMapping.size()]));
super.setItems(this.valueMapping.toArray(new String[0]));
}
@Override

9
src/main/java/ch/ethz/seb/sebserver/gui/widget/WidgetFactory.java
View file

@ -123,7 +123,7 @@ public class WidgetFactory {
private ImageData image = null;
private ImageData greyedImage = null;
private ImageIcon(final String fileName) {
ImageIcon(final String fileName) {
this.fileName = fileName;
}
@ -199,7 +199,7 @@ public class WidgetFactory {
public final String key;
private CustomVariant(final String key) {
CustomVariant(final String key) {
this.key = key;
}
}
@ -268,7 +268,7 @@ public class WidgetFactory {
* @param parent The parent Composite
* @return the scrolled Composite to add the form content */
public Composite createPopupScrollComposite(final Composite parent) {
final Composite grid = PageService.createManagedVScrolledComposite(
return PageService.createManagedVScrolledComposite(
parent,
scrolledComposite -> {
final Composite g = new Composite(scrolledComposite, SWT.NONE);
@ -277,7 +277,6 @@ public class WidgetFactory {
return g;
},
false);
return grid;
}
public Composite createWarningPanel(final Composite parent) {
@ -733,7 +732,7 @@ public class WidgetFactory {
new FileUploadSelection(parent, this.i18nSupport, readonly);
if (supportedFiles != null) {
supportedFiles.forEach(ext -> fileUploadSelection.withSupportFor(ext));
supportedFiles.forEach(fileUploadSelection::withSupportFor);
}
return fileUploadSelection;
}

219
src/main/java/ch/ethz/seb/sebserver/webservice/WebserviceInit.java
View file

@ -1,113 +1,106 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.webservice;
import java.net.InetAddress;
import java.net.UnknownHostException;
import javax.annotation.PreDestroy;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Import;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.SEBServerInit;
import ch.ethz.seb.sebserver.SEBServerInitEvent;
import ch.ethz.seb.sebserver.gbl.profile.WebServiceProfile;
@Component
@WebServiceProfile
@Import(DataSourceAutoConfiguration.class)
public class WebserviceInit implements ApplicationListener<ApplicationReadyEvent> {
private final SEBServerInit sebServerInit;
private final Environment environment;
private final WebserviceInfo webserviceInfo;
private final AdminUserInitializer adminUserInitializer;
private final ApplicationEventPublisher applicationEventPublisher;
protected WebserviceInit(
final SEBServerInit sebServerInit,
final Environment environment,
final WebserviceInfo webserviceInfo,
final AdminUserInitializer adminUserInitializer,
final ApplicationEventPublisher applicationEventPublisher) {
this.sebServerInit = sebServerInit;
this.environment = environment;
this.webserviceInfo = webserviceInfo;
this.adminUserInitializer = adminUserInitializer;
this.applicationEventPublisher = applicationEventPublisher;
}
@Override
public void onApplicationEvent(final ApplicationReadyEvent event) {
this.sebServerInit.init();
SEBServerInit.INIT_LOGGER.info("----> **** Webservice starting up... ****");
SEBServerInit.INIT_LOGGER.info("----> ");
SEBServerInit.INIT_LOGGER.info("----> Init Database with flyway...");
SEBServerInit.INIT_LOGGER.info("----> TODO ");
// TODO integration of Flyway for database initialization and migration: https://flywaydb.org
// see also https://flywaydb.org/getstarted/firststeps/api
SEBServerInit.INIT_LOGGER.info("----> ");
SEBServerInit.INIT_LOGGER.info("----> Intitialize Services...");
SEBServerInit.INIT_LOGGER.info("----> ");
this.applicationEventPublisher.publishEvent(new SEBServerInitEvent(this));
SEBServerInit.INIT_LOGGER.info("----> ");
SEBServerInit.INIT_LOGGER.info("----> **** Webservice successfully started up! **** ");
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> *** Info:");
try {
SEBServerInit.INIT_LOGGER.info("----> Server address: {}", this.environment.getProperty("server.address"));
SEBServerInit.INIT_LOGGER.info("----> Server port: {}", this.environment.getProperty("server.port"));
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> Local-Host address: {}", InetAddress.getLocalHost().getHostAddress());
SEBServerInit.INIT_LOGGER.info("----> Local-Host name: {}", InetAddress.getLocalHost().getHostName());
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> Remote-Host address: {}",
InetAddress.getLoopbackAddress().getHostAddress());
SEBServerInit.INIT_LOGGER.info("----> Remote-Host name: {}",
InetAddress.getLoopbackAddress().getHostName());
} catch (final UnknownHostException e) {
SEBServerInit.INIT_LOGGER.error("Unknown Host: ", e);
}
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> External-Host URL: {}", this.webserviceInfo.getExternalServerURL());
SEBServerInit.INIT_LOGGER.info("----> LMS-External-Address-Alias: {}",
this.webserviceInfo.getLmsExternalAddressAlias());
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> HTTP Scheme {}", this.webserviceInfo.getHttpScheme());
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> Property Override Test: {}", this.webserviceInfo.getTestProperty());
// Create an initial admin account if requested and not already in the data-base
this.adminUserInitializer.initAdminAccount();
}
@PreDestroy
public void gracefulShutdown() {
SEBServerInit.INIT_LOGGER.info("**** Gracefully Shutdown of SEB Server instance {} ****",
this.webserviceInfo.getHostAddress());
}
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.webservice;
import java.net.InetAddress;
import java.net.UnknownHostException;
import javax.annotation.PreDestroy;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Import;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.SEBServerInit;
import ch.ethz.seb.sebserver.SEBServerInitEvent;
import ch.ethz.seb.sebserver.gbl.profile.WebServiceProfile;
@Component
@WebServiceProfile
@Import(DataSourceAutoConfiguration.class)
public class WebserviceInit implements ApplicationListener<ApplicationReadyEvent> {
private final SEBServerInit sebServerInit;
private final Environment environment;
private final WebserviceInfo webserviceInfo;
private final AdminUserInitializer adminUserInitializer;
private final ApplicationEventPublisher applicationEventPublisher;
protected WebserviceInit(
final SEBServerInit sebServerInit,
final Environment environment,
final WebserviceInfo webserviceInfo,
final AdminUserInitializer adminUserInitializer,
final ApplicationEventPublisher applicationEventPublisher) {
this.sebServerInit = sebServerInit;
this.environment = environment;
this.webserviceInfo = webserviceInfo;
this.adminUserInitializer = adminUserInitializer;
this.applicationEventPublisher = applicationEventPublisher;
}
@Override
public void onApplicationEvent(final ApplicationReadyEvent event) {
this.sebServerInit.init();
SEBServerInit.INIT_LOGGER.info("----> **** Webservice starting up... ****");
SEBServerInit.INIT_LOGGER.info("----> ");
SEBServerInit.INIT_LOGGER.info("----> Intitialize Services...");
SEBServerInit.INIT_LOGGER.info("----> ");
this.applicationEventPublisher.publishEvent(new SEBServerInitEvent(this));
SEBServerInit.INIT_LOGGER.info("----> ");
SEBServerInit.INIT_LOGGER.info("----> **** Webservice successfully started up! **** ");
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> *** Info:");
try {
SEBServerInit.INIT_LOGGER.info("----> Server address: {}", this.environment.getProperty("server.address"));
SEBServerInit.INIT_LOGGER.info("----> Server port: {}", this.environment.getProperty("server.port"));
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> Local-Host address: {}", InetAddress.getLocalHost().getHostAddress());
SEBServerInit.INIT_LOGGER.info("----> Local-Host name: {}", InetAddress.getLocalHost().getHostName());
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> Remote-Host address: {}",
InetAddress.getLoopbackAddress().getHostAddress());
SEBServerInit.INIT_LOGGER.info("----> Remote-Host name: {}",
InetAddress.getLoopbackAddress().getHostName());
} catch (final UnknownHostException e) {
SEBServerInit.INIT_LOGGER.error("Unknown Host: ", e);
}
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> External-Host URL: {}", this.webserviceInfo.getExternalServerURL());
SEBServerInit.INIT_LOGGER.info("----> LMS-External-Address-Alias: {}",
this.webserviceInfo.getLmsExternalAddressAlias());
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> HTTP Scheme {}", this.webserviceInfo.getHttpScheme());
SEBServerInit.INIT_LOGGER.info("---->");
SEBServerInit.INIT_LOGGER.info("----> Property Override Test: {}", this.webserviceInfo.getTestProperty());
// Create an initial admin account if requested and not already in the data-base
this.adminUserInitializer.initAdminAccount();
}
@PreDestroy
public void gracefulShutdown() {
SEBServerInit.INIT_LOGGER.info("**** Gracefully Shutdown of SEB Server instance {} ****",
this.webserviceInfo.getHostAddress());
}
}

5
src/main/java/ch/ethz/seb/sebserver/webservice/servicelayer/lms/LmsAPIService.java
View file

@ -23,6 +23,7 @@ import ch.ethz.seb.sebserver.gbl.model.institution.LmsSetup;
import ch.ethz.seb.sebserver.gbl.model.institution.LmsSetupTestResult;
import ch.ethz.seb.sebserver.gbl.util.Result;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.FilterMap;
import org.joda.time.DateTimeZone;
/** Defines the LMS API access service interface with all functionality needed to access
* a LMS API within a given LmsSetup configuration.
@ -101,12 +102,12 @@ public interface LmsAPIService {
static Predicate<QuizData> quizFilterPredicate(final FilterMap filterMap) {
final String name = filterMap.getQuizName();
final DateTime from = filterMap.getQuizFromTime();
//final DateTime now = DateTime.now(DateTimeZone.UTC);
return q -> {
final boolean nameFilter = StringUtils.isBlank(name) || (q.name != null && q.name.contains(name));
final boolean startTimeFilter =
(from == null) || (q.startTime != null && (q.startTime.isEqual(from) || q.startTime.isAfter(from)));
return nameFilter && startTimeFilter /* && endTimeFilter */;
final boolean currentlyRunning = DateTime.now(DateTimeZone.UTC).isBefore(q.endTime);
return nameFilter && (startTimeFilter || currentlyRunning) ;
};
}

12
src/main/java/ch/ethz/seb/sebserver/webservice/servicelayer/sebconfig/ClientConfigService.java
View file

@ -60,10 +60,10 @@ public interface ClientConfigService {
unless = "#result.hasError()")
Result<ClientDetails> getClientConfigDetails(String clientName);
@CacheEvict(
cacheNames = EXAM_CLIENT_DETAILS_CACHE,
allEntries = true)
@EventListener(BulkActionEvent.class)
void flushClientConfigData(BulkActionEvent event);
/** Internally used to check OAuth2 access for a active SebClientConfig.
*
* @param config the SebClientConfig to check access
* @return true if the system was able to gain an access token for the client. False otherwise
*/
boolean checkAccess(SebClientConfig config);
}

62
src/main/java/ch/ethz/seb/sebserver/webservice/servicelayer/sebconfig/impl/ClientConfigServiceImpl.java
View file

@ -10,8 +10,7 @@ package ch.ethz.seb.sebserver.webservice.servicelayer.sebconfig.impl;
import ch.ethz.seb.sebserver.WebSecurityConfig;
import ch.ethz.seb.sebserver.gbl.Constants;
import ch.ethz.seb.sebserver.gbl.api.API.BulkActionType;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.model.EntityKey;
import ch.ethz.seb.sebserver.gbl.model.institution.Institution;
import ch.ethz.seb.sebserver.gbl.model.sebconfig.SebClientConfig;
@ -19,8 +18,6 @@ import ch.ethz.seb.sebserver.gbl.profile.WebServiceProfile;
import ch.ethz.seb.sebserver.gbl.util.Result;
import ch.ethz.seb.sebserver.gbl.util.Utils;
import ch.ethz.seb.sebserver.webservice.WebserviceInfo;
import ch.ethz.seb.sebserver.webservice.servicelayer.bulkaction.impl.BulkAction;
import ch.ethz.seb.sebserver.webservice.servicelayer.bulkaction.impl.BulkActionEvent;
import ch.ethz.seb.sebserver.webservice.servicelayer.client.ClientCredentialService;
import ch.ethz.seb.sebserver.webservice.servicelayer.client.ClientCredentials;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.InstitutionDAO;
@ -38,12 +35,21 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Lazy;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.security.oauth2.common.OAuth2AccessToken;
import org.springframework.security.oauth2.provider.ClientDetails;
import org.springframework.security.oauth2.provider.client.BaseClientDetails;
import org.springframework.security.oauth2.provider.token.TokenStore;
import org.springframework.stereotype.Service;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestTemplate;
import java.io.IOException;
import java.io.InputStream;
@ -51,6 +57,7 @@ import java.io.OutputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.Collection;
import java.util.Collections;
import java.util.UUID;
@ -316,19 +323,48 @@ public class ClientConfigServiceImpl implements ClientConfigService {
}
@Override
public void flushClientConfigData(final BulkActionEvent event) {
public boolean checkAccess(SebClientConfig config) {
if(!config.isActive()) {
return false;
}
try {
final BulkAction bulkAction = event.getBulkAction();
RestTemplate restTemplate = new RestTemplate();
String externalServerURL = webserviceInfo.getExternalServerURL() +
API.OAUTH_TOKEN_ENDPOINT;
if (bulkAction.type == BulkActionType.DEACTIVATE ||
bulkAction.type == BulkActionType.HARD_DELETE) {
MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
headers.add(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_FORM_URLENCODED_VALUE);
ClientCredentials credentials = sebClientConfigDAO
.getSebClientCredentials(config.getModelId())
.getOrThrow();
CharSequence plainClientSecret = clientCredentialService.getPlainClientSecret(credentials);
String basicAuth = credentials.clientId +
String.valueOf(Constants.COLON) +
plainClientSecret;
String encoded = Base64.getEncoder()
.encodeToString(basicAuth.getBytes());
bulkAction.extractKeys(EntityType.SEB_CLIENT_CONFIGURATION)
.forEach(this::flushClientConfigData);
headers.add(HttpHeaders.AUTHORIZATION, "Basic " + encoded);
HttpEntity<String> entity = new HttpEntity<>(
"grant_type=client_credentials&scope=read write",
headers);
ResponseEntity<String> exchange = restTemplate.exchange(
externalServerURL,
HttpMethod.POST,
entity,
String.class);
if (exchange.getStatusCode().value() == HttpStatus.OK.value()) {
return true;
} else {
log.warn("Failed to check access SebClientConfig {} response: {}", config, exchange.getStatusCode());
return false;
}
} catch (final Exception e) {
log.error("Unexpected error while trying to flush ClientConfig data ", e);
} catch (Exception e) {
log.warn("Failed to check access for SebClientConfig: {} cause: {}", config, e.getMessage());
return false;
}
}

230
src/main/java/ch/ethz/seb/sebserver/webservice/servicelayer/session/impl/ClientIndicatorFactory.java
View file

@ -1,109 +1,121 @@
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.webservice.servicelayer.session.impl;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator.IndicatorType;
import ch.ethz.seb.sebserver.gbl.model.session.ClientConnection;
import ch.ethz.seb.sebserver.gbl.profile.WebServiceProfile;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.IndicatorDAO;
import ch.ethz.seb.sebserver.webservice.servicelayer.session.ClientIndicator;
@Lazy
@Component
@WebServiceProfile
public class ClientIndicatorFactory {
private static final Logger log = LoggerFactory.getLogger(ClientIndicatorFactory.class);
private final ApplicationContext applicationContext;
private final IndicatorDAO indicatorDAO;
private final boolean enableCaching;
@Autowired
public ClientIndicatorFactory(
final ApplicationContext applicationContext,
final IndicatorDAO indicatorDAO,
@Value("${sebserver.webservice.api.exam.enable-indicator-cache:true}") final boolean enableCaching) {
this.applicationContext = applicationContext;
this.indicatorDAO = indicatorDAO;
this.enableCaching = enableCaching;
}
public List<ClientIndicator> createFor(final ClientConnection clientConnection) {
final List<ClientIndicator> result = new ArrayList<>();
if (clientConnection.examId == null) {
return result;
}
try {
final Collection<Indicator> examIndicators = this.indicatorDAO
.allForExam(clientConnection.examId)
.getOrThrow();
boolean pingIndicatorAvailable = false;
for (final Indicator indicatorDef : examIndicators) {
try {
final ClientIndicator indicator = this.applicationContext
.getBean(indicatorDef.type.name(), ClientIndicator.class);
if (!pingIndicatorAvailable) {
pingIndicatorAvailable = indicatorDef.type == IndicatorType.LAST_PING;
}
indicator.init(
indicatorDef,
clientConnection.id,
this.enableCaching);
result.add(indicator);
} catch (final Exception e) {
log.warn("No Indicator with type: {} found as registered bean. Ignore this one.", indicatorDef.type,
e);
}
}
// If there is no ping interval indicator set from the exam, we add a hidden one
// to at least create missing ping events and track missing state
if (!pingIndicatorAvailable) {
final PingIntervalClientIndicator pingIndicator = this.applicationContext
.getBean(PingIntervalClientIndicator.class);
pingIndicator.hidden = true;
result.add(pingIndicator);
}
} catch (final RuntimeException e) {
log.error("Failed to create ClientIndicator for ClientConnection: {}", clientConnection);
throw e;
} catch (final Exception e) {
log.error("Failed to create ClientIndicator for ClientConnection: {}", clientConnection);
}
return Collections.unmodifiableList(result);
}
}
/*
* Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.webservice.servicelayer.session.impl;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator;
import ch.ethz.seb.sebserver.gbl.model.exam.Indicator.IndicatorType;
import ch.ethz.seb.sebserver.gbl.model.session.ClientConnection;
import ch.ethz.seb.sebserver.gbl.profile.WebServiceProfile;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.IndicatorDAO;
import ch.ethz.seb.sebserver.webservice.servicelayer.session.ClientIndicator;
@Lazy
@Component
@WebServiceProfile
public class ClientIndicatorFactory {
private static final Logger log = LoggerFactory.getLogger(ClientIndicatorFactory.class);
private final ApplicationContext applicationContext;
private final IndicatorDAO indicatorDAO;
private final boolean enableCaching;
@Autowired
public ClientIndicatorFactory(
final ApplicationContext applicationContext,
final IndicatorDAO indicatorDAO,
@Value("${sebserver.webservice.api.exam.enable-indicator-cache:true}") final boolean enableCaching) {
this.applicationContext = applicationContext;
this.indicatorDAO = indicatorDAO;
this.enableCaching = enableCaching;
}
public List<ClientIndicator> createFor(final ClientConnection clientConnection) {
final List<ClientIndicator> result = new ArrayList<>();
if (clientConnection.examId == null) {
return result;
}
try {
final Collection<Indicator> examIndicators = this.indicatorDAO
.allForExam(clientConnection.examId)
.getOrThrow();
boolean pingIndicatorAvailable = false;
for (final Indicator indicatorDef : examIndicators) {
try {
final ClientIndicator indicator = this.applicationContext
.getBean(indicatorDef.type.name(), ClientIndicator.class);
if (!pingIndicatorAvailable) {
pingIndicatorAvailable = indicatorDef.type == IndicatorType.LAST_PING;
}
indicator.init(
indicatorDef,
clientConnection.id,
this.enableCaching);
result.add(indicator);
} catch (final Exception e) {
log.warn("No Indicator with type: {} found as registered bean. Ignore this one.", indicatorDef.type,
e);
}
}
// If there is no ping interval indicator set from the exam, we add a hidden one
// to at least create missing ping events and track missing state
if (!pingIndicatorAvailable) {
final PingIntervalClientIndicator pingIndicator = this.applicationContext
.getBean(PingIntervalClientIndicator.class);
pingIndicator.hidden = true;
final Indicator indicator = new Indicator(
null,
clientConnection.examId,
"hidden_ping_indicator",
IndicatorType.LAST_PING,
"",
Arrays.asList(new Indicator.Threshold(5000d, "")));
pingIndicator.init(
indicator,
clientConnection.id,
this.enableCaching);
result.add(pingIndicator);
}
} catch (final RuntimeException e) {
log.error("Failed to create ClientIndicator for ClientConnection: {}", clientConnection);
throw e;
} catch (final Exception e) {
log.error("Failed to create ClientIndicator for ClientConnection: {}", clientConnection);
}
return Collections.unmodifiableList(result);
}
}

1
src/main/java/ch/ethz/seb/sebserver/webservice/servicelayer/session/impl/PingIntervalClientIndicator.java
View file

@ -38,7 +38,6 @@ public final class PingIntervalClientIndicator extends AbstractPingIndicator {
long pingErrorThreshold;
boolean missingPing = false;
boolean hidden = false;
public PingIntervalClientIndicator(final ClientEventExtensionMapper clientEventExtensionMapper) {

276
src/main/java/ch/ethz/seb/sebserver/webservice/weblayer/api/ClientEventController.java
View file

@ -1,135 +1,141 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.webservice.weblayer.api;
import java.util.Collection;
import org.mybatis.dynamic.sql.SqlTable;
import org.springframework.http.MediaType;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.api.API.BulkActionType;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.api.authorization.PrivilegeType;
import ch.ethz.seb.sebserver.gbl.model.EntityKey;
import ch.ethz.seb.sebserver.gbl.model.GrantEntity;
import ch.ethz.seb.sebserver.gbl.model.Page;
import ch.ethz.seb.sebserver.gbl.model.session.ClientEvent;
import ch.ethz.seb.sebserver.gbl.model.session.ExtendedClientEvent;
import ch.ethz.seb.sebserver.gbl.profile.WebServiceProfile;
import ch.ethz.seb.sebserver.webservice.datalayer.batis.mapper.ClientEventRecordDynamicSqlSupport;
import ch.ethz.seb.sebserver.webservice.servicelayer.PaginationService;
import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.AuthorizationService;
import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.PermissionDeniedException;
import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.UserService;
import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.impl.SEBServerUser;
import ch.ethz.seb.sebserver.webservice.servicelayer.bulkaction.BulkActionService;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.ClientEventDAO;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.ExamDAO;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.FilterMap;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.UserActivityLogDAO;
import ch.ethz.seb.sebserver.webservice.servicelayer.validation.BeanValidationService;
@WebServiceProfile
@RestController
@RequestMapping("${sebserver.webservice.api.admin.endpoint}" + API.SEB_CLIENT_EVENT_ENDPOINT)
public class ClientEventController extends ReadonlyEntityController<ClientEvent, ClientEvent> {
private final ExamDAO examDAO;
private final ClientEventDAO clientEventDAO;
protected ClientEventController(
final AuthorizationService authorization,
final BulkActionService bulkActionService,
final ClientEventDAO entityDAO,
final UserActivityLogDAO userActivityLogDAO,
final PaginationService paginationService,
final BeanValidationService beanValidationService,
final ExamDAO examDAO) {
super(authorization,
bulkActionService,
entityDAO,
userActivityLogDAO,
paginationService,
beanValidationService);
this.examDAO = examDAO;
this.clientEventDAO = entityDAO;
}
@RequestMapping(
path = API.SEB_CLIENT_EVENT_SEARCH_PATH_SEGMENT,
method = RequestMethod.GET,
consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE,
produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public Page<ExtendedClientEvent> getExtendedPage(
@RequestParam(
name = API.PARAM_INSTITUTION_ID,
required = true,
defaultValue = UserService.USERS_INSTITUTION_AS_DEFAULT) final Long institutionId,
@RequestParam(name = Page.ATTR_PAGE_NUMBER, required = false) final Integer pageNumber,
@RequestParam(name = Page.ATTR_PAGE_SIZE, required = false) final Integer pageSize,
@RequestParam(name = Page.ATTR_SORT, required = false) final String sort,
@RequestParam final MultiValueMap<String, String> allRequestParams) {
// at least current user must have base read access for specified entity type within its own institution
checkReadPrivilege(institutionId);
final FilterMap filterMap = new FilterMap(allRequestParams);
// if current user has no read access for specified entity type within other institution
// then the current users institutionId is put as a SQL filter criteria attribute to extends query performance
if (!this.authorization.hasGrant(PrivilegeType.READ, getGrantEntityType())) {
filterMap.putIfAbsent(API.PARAM_INSTITUTION_ID, String.valueOf(institutionId));
}
return this.paginationService.getPage(
pageNumber,
pageSize,
sort,
getSQLTableOfEntity().name(),
() -> this.clientEventDAO.allMatchingExtended(filterMap, this::hasReadAccess))
.getOrThrow();
}
@Override
public Collection<EntityKey> getDependencies(final String modelId, final BulkActionType bulkActionType) {
throw new UnsupportedOperationException();
}
@Override
protected SqlTable getSQLTableOfEntity() {
return ClientEventRecordDynamicSqlSupport.clientEventRecord;
}
@Override
protected GrantEntity toGrantEntity(final ClientEvent entity) {
return this.examDAO
.byClientConnection(entity.connectionId)
.getOrThrow();
}
@Override
protected void checkReadPrivilege(final Long institutionId) {
final SEBServerUser currentUser = this.authorization.getUserService().getCurrentUser();
if (currentUser.institutionId().longValue() != institutionId.longValue()) {
throw new PermissionDeniedException(
EntityType.CLIENT_EVENT,
PrivilegeType.READ,
currentUser.getUserInfo());
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.webservice.weblayer.api;
import java.util.Collection;
import org.mybatis.dynamic.sql.SqlTable;
import org.springframework.http.MediaType;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import ch.ethz.seb.sebserver.gbl.api.API;
import ch.ethz.seb.sebserver.gbl.api.API.BulkActionType;
import ch.ethz.seb.sebserver.gbl.api.EntityType;
import ch.ethz.seb.sebserver.gbl.api.authorization.PrivilegeType;
import ch.ethz.seb.sebserver.gbl.model.EntityKey;
import ch.ethz.seb.sebserver.gbl.model.GrantEntity;
import ch.ethz.seb.sebserver.gbl.model.Page;
import ch.ethz.seb.sebserver.gbl.model.session.ClientEvent;
import ch.ethz.seb.sebserver.gbl.model.session.ExtendedClientEvent;
import ch.ethz.seb.sebserver.gbl.profile.WebServiceProfile;
import ch.ethz.seb.sebserver.webservice.datalayer.batis.mapper.ClientEventRecordDynamicSqlSupport;
import ch.ethz.seb.sebserver.webservice.servicelayer.PaginationService;
import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.AuthorizationService;
import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.PermissionDeniedException;
import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.UserService;
import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.impl.SEBServerUser;
import ch.ethz.seb.sebserver.webservice.servicelayer.bulkaction.BulkActionService;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.ClientEventDAO;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.ExamDAO;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.FilterMap;
import ch.ethz.seb.sebserver.webservice.servicelayer.dao.UserActivityLogDAO;
import ch.ethz.seb.sebserver.webservice.servicelayer.validation.BeanValidationService;
@WebServiceProfile
@RestController
@RequestMapping("${sebserver.webservice.api.admin.endpoint}" + API.SEB_CLIENT_EVENT_ENDPOINT)
public class ClientEventController extends ReadonlyEntityController<ClientEvent, ClientEvent> {
private final ExamDAO examDAO;
private final ClientEventDAO clientEventDAO;
protected ClientEventController(
final AuthorizationService authorization,
final BulkActionService bulkActionService,
final ClientEventDAO entityDAO,
final UserActivityLogDAO userActivityLogDAO,
final PaginationService paginationService,
final BeanValidationService beanValidationService,
final ExamDAO examDAO) {
super(authorization,
bulkActionService,
entityDAO,
userActivityLogDAO,
paginationService,
beanValidationService);
this.examDAO = examDAO;
this.clientEventDAO = entityDAO;
}
@RequestMapping(
path = API.SEB_CLIENT_EVENT_SEARCH_PATH_SEGMENT,
method = RequestMethod.GET,
consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE,
produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public Page<ExtendedClientEvent> getExtendedPage(
@RequestParam(
name = API.PARAM_INSTITUTION_ID,
required = true,
defaultValue = UserService.USERS_INSTITUTION_AS_DEFAULT) final Long institutionId,
@RequestParam(name = Page.ATTR_PAGE_NUMBER, required = false) final Integer pageNumber,
@RequestParam(name = Page.ATTR_PAGE_SIZE, required = false) final Integer pageSize,
@RequestParam(name = Page.ATTR_SORT, required = false) final String sort,
@RequestParam final MultiValueMap<String, String> allRequestParams) {
// at least current user must have base read access for specified entity type within its own institution
checkReadPrivilege(institutionId);
final FilterMap filterMap = new FilterMap(allRequestParams);
// if current user has no read access for specified entity type within other institution
// then the current users institutionId is put as a SQL filter criteria attribute to extends query performance
if (!this.authorization.hasGrant(PrivilegeType.READ, getGrantEntityType())) {
filterMap.putIfAbsent(API.PARAM_INSTITUTION_ID, String.valueOf(institutionId));
}
try {
return this.paginationService.getPage(
pageNumber,
pageSize,
sort,
getSQLTableOfEntity().name(),
() -> this.clientEventDAO.allMatchingExtended(filterMap, this::hasReadAccess))
.getOrThrow();
} catch (Exception e) {
e.printStackTrace();
throw e;
}
}
@Override
public Collection<EntityKey> getDependencies(final String modelId, final BulkActionType bulkActionType) {
throw new UnsupportedOperationException();
}
@Override
protected SqlTable getSQLTableOfEntity() {
return ClientEventRecordDynamicSqlSupport.clientEventRecord;
}
@Override
protected GrantEntity toGrantEntity(final ClientEvent entity) {
return this.examDAO
.byClientConnection(entity.connectionId)
.get();
}
@Override
protected void checkReadPrivilege(final Long institutionId) {
final SEBServerUser currentUser = this.authorization.getUserService().getCurrentUser();
if (currentUser.institutionId().longValue() != institutionId.longValue()) {
throw new PermissionDeniedException(
EntityType.CLIENT_EVENT,
PrivilegeType.READ,
currentUser.getUserInfo());
}
}
}

10
src/main/java/ch/ethz/seb/sebserver/webservice/weblayer/api/SebClientConfigController.java
View file

@ -39,6 +39,7 @@ import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
@ -144,6 +145,15 @@ public class SebClientConfigController extends ActivatableEntityController<SebCl
.map(this::checkPasswordMatch);
}
@Override
protected Result<SebClientConfig> notifySaved(SebClientConfig entity) {
if (entity.isActive()) {
// try to get access token for SEB client
sebClientConfigService.checkAccess(entity);
}
return super.notifySaved(entity);
}
private SebClientConfig checkPasswordMatch(final SebClientConfig entity) {
Collection<APIMessage> errors = new ArrayList<>();
if (entity.hasEncryptionSecret() && !entity.encryptSecret.equals(entity.encryptSecretConfirm)) {

117
src/main/java/ch/ethz/seb/sebserver/webservice/weblayer/oauth/DefaultTokenServicesFallback.java
View file

@ -1,58 +1,59 @@
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.webservice.weblayer.oauth;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.security.core.AuthenticationException;
import org.springframework.security.oauth2.common.OAuth2AccessToken;
import org.springframework.security.oauth2.provider.OAuth2Authentication;
import org.springframework.security.oauth2.provider.token.DefaultTokenServices;
public class DefaultTokenServicesFallback extends DefaultTokenServices {
private static final Logger log = LoggerFactory.getLogger(DefaultTokenServicesFallback.class);
@Override
public OAuth2AccessToken createAccessToken(final OAuth2Authentication authentication)
throws AuthenticationException {
try {
return super.createAccessToken(authentication);
} catch (final DuplicateKeyException e) {
log.info(
"Catched DuplicateKeyException, try to handle it by trying to get the already stored access token after waited some time");
final String clientName = authentication.getName();
if (StringUtils.isNotBlank(clientName)) {
// wait a second...
try {
Thread.sleep(1000);
} catch (final InterruptedException e1) {
log.warn("Failed to sleep: {}", e1.getMessage());
}
final OAuth2AccessToken accessToken = this.getAccessToken(authentication);
if (accessToken != null) {
log.info("Found original accees token for client: {} token: {}", clientName, accessToken);
return accessToken;
}
}
// If no access token is available, propagate the original exception
log.error("Unable the handle DuplicateKeyException properly", e);
throw e;
}
}
}
/*
* Copyright (c) 2019 ETH Zürich, Educational Development and Technology (LET)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package ch.ethz.seb.sebserver.webservice.weblayer.oauth;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.security.core.AuthenticationException;
import org.springframework.security.oauth2.common.OAuth2AccessToken;
import org.springframework.security.oauth2.provider.OAuth2Authentication;
import org.springframework.security.oauth2.provider.token.DefaultTokenServices;
// TODO check if we can apply some caching here to get better performance for SEB client connection attempts
public class DefaultTokenServicesFallback extends DefaultTokenServices {
private static final Logger log = LoggerFactory.getLogger(DefaultTokenServicesFallback.class);
@Override
public OAuth2AccessToken createAccessToken(final OAuth2Authentication authentication)
throws AuthenticationException {
try {
return super.createAccessToken(authentication);
} catch (final DuplicateKeyException e) {
log.warn(
"Caught DuplicateKeyException, try to handle it by trying to get the already stored access token after waited some time");
final String clientName = authentication.getName();
if (StringUtils.isNotBlank(clientName)) {
// wait some time...
try {
Thread.sleep(500);
} catch (final InterruptedException e1) {
log.warn("Failed to sleep: {}", e1.getMessage());
}
final OAuth2AccessToken accessToken = this.getAccessToken(authentication);
if (accessToken != null) {
log.debug("Found original access token for client: {} ", clientName);
return accessToken;
}
}
// If no access token is available, propagate the original exception
log.error("Unable the handle DuplicateKeyException properly", e);
throw e;
}
}
}

140
src/main/resources/config/application-dev-ws.properties
View file

@ -1,71 +1,71 @@
server.address=localhost
server.port=8090
logging.file=log/sebserver.log
# data source configuration
spring.datasource.initialize=true
spring.datasource.initialization-mode=always
spring.datasource.url=jdbc:mariadb://localhost:3306/SEBServer?createDatabaseIfNotExist=true&verifyServerCertificate=false&useSSL=false&requireSSL=false
spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
spring.flyway.enabled=true
spring.flyway.locations=classpath:config/sql/base,classpath:config/sql/dev
spring.flyway.baselineOnMigrate=true
spring.datasource.hikari.initializationFailTimeout=30000
spring.datasource.hikari.connectionTimeout=30000
spring.datasource.hikari.idleTimeout=600000
spring.datasource.hikari.maxLifetime=1800000
sebserver.http.client.connect-timeout=15000
sebserver.http.client.connection-request-timeout=10000
sebserver.http.client.read-timeout=20000
# webservice configuration
sebserver.init.adminaccount.gen-on-init=false
sebserver.webservice.distributed=false
sebserver.webservice.http.scheme=http
sebserver.webservice.http.external.servername=
sebserver.webservice.http.external.port=
sebserver.webservice.http.redirect.gui=/gui
sebserver.webservice.api.admin.endpoint=/admin-api/v1
sebserver.webservice.api.admin.accessTokenValiditySeconds=3600
sebserver.webservice.api.admin.refreshTokenValiditySeconds=-1
sebserver.webservice.api.exam.config.init.permittedProcesses=config/initialPermittedProcesses.xml
sebserver.webservice.api.exam.config.init.prohibitedProcesses=config/initialProhibitedProcesses.xml
sebserver.webservice.api.exam.update-interval=1 * * * * *
sebserver.webservice.api.exam.time-prefix=0
sebserver.webservice.api.exam.time-suffix=0
sebserver.webservice.api.exam.endpoint=/exam-api
sebserver.webservice.api.exam.endpoint.discovery=${sebserver.webservice.api.exam.endpoint}/discovery
sebserver.webservice.api.exam.endpoint.v1=${sebserver.webservice.api.exam.endpoint}/v1
sebserver.webservice.api.exam.accessTokenValiditySeconds=3600
sebserver.webservice.api.exam.event-handling-strategy=ASYNC_BATCH_STORE_STRATEGY
sebserver.webservice.api.exam.enable-indicator-cache=true
sebserver.webservice.api.pagination.maxPageSize=500
# comma separated list of known possible OpenEdX API access token request endpoints
sebserver.webservice.lms.openedx.api.token.request.paths=/oauth2/access_token
sebserver.webservice.lms.moodle.api.token.request.paths=
sebserver.webservice.lms.address.alias=lms.mockup.com=lms.address.alias
# NOTE: This is a temporary work-around for SEB Restriction API within Open edX SEB integration plugin to
# apply on load-balanced infrastructure or infrastructure that has several layers of cache.
# The reason for this is that the API (Open edX system) internally don't apply a resource-change that is
# done within HTTP API call immediately from an outside perspective.
# After a resource-change on the API is done, the system toggles between the old and the new resource
# while constantly calling GET. This usually happens for about a minute or two then it stabilizes on the new resource
#
# This may source on load-balancing or internally caching on Open edX side.
# To mitigate this effect the SEB Server can be configured to apply a resource-change on the
# API several times in a row to flush as match caches and reach as match as possible server instances.
#
# Since this is a brute-force method to mitigate the problem, this should only be a temporary
# work-around until a better solution on Open edX SEB integration side has been found and applied.
#sebserver.webservice.lms.openedx.seb.restriction.push-count=10
# actuator configuration
management.server.port=${server.port}
management.endpoints.web.base-path=/management
management.endpoints.web.exposure.include=logfile,loggers,jolokia
server.address=localhost
server.port=8090
logging.file=log/sebserver.log
# data source configuration
spring.datasource.initialize=true
spring.datasource.initialization-mode=always
spring.datasource.url=jdbc:mariadb://localhost:3306/SEBServer?createDatabaseIfNotExist=true&verifyServerCertificate=false&useSSL=false&requireSSL=false
spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
spring.flyway.enabled=true
spring.flyway.locations=classpath:config/sql/base,classpath:config/sql/dev
spring.flyway.baselineOnMigrate=true
spring.datasource.hikari.initializationFailTimeout=30000
spring.datasource.hikari.connectionTimeout=30000
spring.datasource.hikari.idleTimeout=600000
spring.datasource.hikari.maxLifetime=1800000
sebserver.http.client.connect-timeout=15000
sebserver.http.client.connection-request-timeout=10000
sebserver.http.client.read-timeout=20000
# webservice configuration
sebserver.init.adminaccount.gen-on-init=false
sebserver.webservice.distributed=false
sebserver.webservice.http.scheme=http
sebserver.webservice.http.external.servername=
sebserver.webservice.http.external.port=${server.port}
sebserver.webservice.http.redirect.gui=/gui
sebserver.webservice.api.admin.endpoint=/admin-api/v1
sebserver.webservice.api.admin.accessTokenValiditySeconds=3600
sebserver.webservice.api.admin.refreshTokenValiditySeconds=-1
sebserver.webservice.api.exam.config.init.permittedProcesses=config/initialPermittedProcesses.xml
sebserver.webservice.api.exam.config.init.prohibitedProcesses=config/initialProhibitedProcesses.xml
sebserver.webservice.api.exam.update-interval=1 * * * * *
sebserver.webservice.api.exam.time-prefix=0
sebserver.webservice.api.exam.time-suffix=0
sebserver.webservice.api.exam.endpoint=/exam-api
sebserver.webservice.api.exam.endpoint.discovery=${sebserver.webservice.api.exam.endpoint}/discovery
sebserver.webservice.api.exam.endpoint.v1=${sebserver.webservice.api.exam.endpoint}/v1
sebserver.webservice.api.exam.accessTokenValiditySeconds=3600
sebserver.webservice.api.exam.event-handling-strategy=ASYNC_BATCH_STORE_STRATEGY
sebserver.webservice.api.exam.enable-indicator-cache=true
sebserver.webservice.api.pagination.maxPageSize=500
# comma separated list of known possible OpenEdX API access token request endpoints
sebserver.webservice.lms.openedx.api.token.request.paths=/oauth2/access_token
sebserver.webservice.lms.moodle.api.token.request.paths=
sebserver.webservice.lms.address.alias=lms.mockup.com=lms.address.alias
# NOTE: This is a temporary work-around for SEB Restriction API within Open edX SEB integration plugin to
# apply on load-balanced infrastructure or infrastructure that has several layers of cache.
# The reason for this is that the API (Open edX system) internally don't apply a resource-change that is
# done within HTTP API call immediately from an outside perspective.
# After a resource-change on the API is done, the system toggles between the old and the new resource
# while constantly calling GET. This usually happens for about a minute or two then it stabilizes on the new resource
#
# This may source on load-balancing or internally caching on Open edX side.
# To mitigate this effect the SEB Server can be configured to apply a resource-change on the
# API several times in a row to flush as match caches and reach as match as possible server instances.
#
# Since this is a brute-force method to mitigate the problem, this should only be a temporary
# work-around until a better solution on Open edX SEB integration side has been found and applied.
#sebserver.webservice.lms.openedx.seb.restriction.push-count=10
# actuator configuration
management.server.port=${server.port}
management.endpoints.web.base-path=/management
management.endpoints.web.exposure.include=logfile,loggers,jolokia
management.endpoints.web.path-mapping.jolokia=jmx

4
src/main/resources/config/sql/base/V2__insert_data_v1_0.sql
View file

@ -175,7 +175,7 @@ INSERT INTO configuration_attribute VALUES
(304, 'enablePrivateClipboard', 'CHECKBOX', null, null, null, null, 'true'),
(305, 'enableLogging', 'CHECKBOX', null, null, null, null, 'false'),
(306, 'logDirectoryWin', 'TEXT_FIELD', null, null, null, null, ''),
(307, 'logDirectoryOSX', 'TEXT_FIELD', null, null, null, null, 'NSTemporaryDirectory'),
(307, 'logDirectoryOSX', 'TEXT_FIELD', null, null, null, null, 'F'),
(308, 'minMacOSVersion', 'SINGLE_SELECTION', null, '0,1,2,3,4,5,6,7', null, null, '0'),
(309, 'enableAppSwitcherCheck', 'CHECKBOX', null, null, null, null, 'true'),
(310, 'forceAppFolderInstall', 'CHECKBOX', null, null, null, null, 'true'),
@ -263,7 +263,7 @@ INSERT INTO configuration_attribute VALUES
(927, 'mobileStatusBarAppearanceExtended', 'SINGLE_SELECTION', null, '0,1,2,3,4', null, null, '1'),
(928, 'newBrowserWindowShowURL', 'SINGLE_SELECTION', null, '0,1,2,3', null, null, '1'),
(929, 'pinEmbeddedCertificates', 'CHECKBOX', null, null, null, null, 'false'),
(930, 'sendBrowserExamKey', 'CHECKBOX', null, null, null, null, 'false'),
(930, 'sendBrowserExamKey', 'CHECKBOX', null, null, null, null, 'true'),
(931, 'showNavigationButtons', 'CHECKBOX', null, null, null, null, 'false'),
(932, 'showScanQRCodeButton', 'CHECKBOX', null, null, null, null, 'false'),
(933, 'startResource', 'TEXT_FIELD', null, null, null, null, ''),

1732
src/test/resources/data-test-additional.sql
View file

File diff suppressed because it is too large Load diff