second commit

This commit is contained in:
Massimiliano Assante 2023-06-08 14:17:59 +02:00
parent 4aa10375ca
commit e4ab69849a
18 changed files with 7 additions and 753 deletions

View File

@ -1,13 +0,0 @@
Manifest-Version: 1.0
Build-Jdk-Spec: 15
Specification-Title: gCube Session Checker Widget
Specification-Version: 1.2
Implementation-Title: gCube Session Checker Widget
Implementation-Version: 1.2.0-SNAPSHOT
Build-Time: 20230608-121104
Created-By: Maven Integration for Eclipse
SCM-Branch:
SCM-Revision:
SCM-Revision-URL: https://code-repo.d4science.org/gCubeSystem/session-ch
ecker/commit/${buildNumber}

View File

@ -1,7 +0,0 @@
#Generated by Maven Integration for Eclipse
#Thu Jun 08 14:14:48 CEST 2023
m2e.projectLocation=/Users/massi/workspace/session-checker-widget
m2e.projectName=session-checker-widget
groupId=org.gcube.portlets.widgets
artifactId=session-checker
version=1.2.0-SNAPSHOT

View File

@ -1,195 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>maven-parent</artifactId>
<groupId>org.gcube.tools</groupId>
<version>1.1.0</version>
<relativePath />
</parent>
<groupId>org.gcube.portlets.widgets</groupId>
<artifactId>session-checker</artifactId>
<packaging>jar</packaging>
<version>1.2.0-SNAPSHOT</version>
<name>gCube Session Checker Widget</name>
<description>
gCube Session Checker Widget is a GWT Widget that can be used to automatically check if the session expired.
</description>
<scm>
<connection>scm:git:https://code-repo.d4science.org/gCubeSystem/${project.artifactId}.git</connection>
<developerConnection>scm:git:https://code-repo.d4science.org/gCubeSystem/${project.artifactId}.git</developerConnection>
<url>https://code-repo.d4science.org/gCubeSystem/${project.artifactId}</url>
</scm>
<properties>
<!-- Convenience property to set the GWT version -->
<gwtVersion>2.7.0</gwtVersion>
<distroDirectory>distro</distroDirectory>
<liferay.version>6.2.5</liferay.version>
<maven.compiler.source>1.7</maven.compiler.source>
<maven.compiler.target>1.7</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.gcube.distribution</groupId>
<artifactId>maven-portal-bom</artifactId>
<version>LATEST</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<!-- Google Web Toolkit (GWT) -->
<dependency>
<groupId>com.google.gwt</groupId>
<artifactId>gwt-user</artifactId>
<version>${gwtVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.gcube.portal</groupId>
<artifactId>custom-portal-handler</artifactId>
<version>[2.0.0-SNAPSHOT,3.0.0-SNAPSHOT)</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.gcube.portlets.user</groupId>
<artifactId>gcube-widgets</artifactId>
<version>[2.0.0-SNAPSHOT,3.0.0-SNAPSHOT)</version>
</dependency>
<dependency>
<groupId>org.gcube.applicationsupportlayer</groupId>
<artifactId>aslcore</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.liferay.portal</groupId>
<artifactId>portal-service</artifactId>
<version>${liferay.version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<!-- Generate compiled stuff in the folder used for developing mode -->
<outputDirectory>${webappDirectory}/WEB-INF/classes</outputDirectory>
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.*</include>
</includes>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.*</include>
</includes>
</resource>
</resources>
<plugins>
<!-- GWT Maven Plugin -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>gwt-maven-plugin</artifactId>
<version>${gwtVersion}</version>
<executions>
<execution>
<configuration>
<module>org.gcube.portlets.widgets.sessionchecker.client.SessionChecker</module>
</configuration>
<goals>
<!-- <goal>compile</goal> -->
<!-- <goal>test</goal> -->
</goals>
</execution>
</executions>
<!-- Plugin configuration. There are many available options, see gwt-maven-plugin
documentation at codehaus.org -->
<configuration>
<runTarget>SessionChecker.html</runTarget>
<hostedWebapp>${webappDirectory}</hostedWebapp>
</configuration>
</plugin>
<!-- Copy static web files before executing gwt:run -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.1.1</version>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>exploded</goal>
</goals>
</execution>
</executions>
<configuration>
<webappDirectory>${webappDirectory}</webappDirectory>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
</configuration>
</plugin>
<!-- SA Plugin -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.2</version>
<configuration>
<descriptors>
<descriptor>${distroDirectory}/descriptor.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<id>servicearchive</id>
<phase>install</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>2.5</version>
<executions>
<execution>
<id>copy-profile</id>
<phase>install</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>target</outputDirectory>
<resources>
<resource>
<directory>${distroDirectory}</directory>
<filtering>true</filtering>
<includes>
<include>profile.xml</include>
</includes>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

View File

@ -1,14 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<module rename-to='SessionChecker'>
<!-- Inherit the core Web Toolkit stuff. -->
<inherits name='com.google.gwt.user.User' />
<inherits name='org.gcube.portlets.user.gcubewidgets.WidgetFactory' />
<!-- Specify the app entry point class. -->
<!-- <entry-point class='org.gcube.portlets.widgets.sessionchecker.client.SessionChecker' /> -->
<!-- Specify the paths for translatable code -->
<source path='client' />
<source path='shared' />
</module>

View File

@ -1,222 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.client;
import java.util.HashMap;
import org.gcube.portlets.user.gcubewidgets.client.popup.GCubeDialog;
import org.gcube.portlets.widgets.sessionchecker.client.bundle.CheckSessionBundle;
import org.gcube.portlets.widgets.sessionchecker.client.elements.Div;
import org.gcube.portlets.widgets.sessionchecker.client.event.SessionTimeoutEvent;
import org.gcube.portlets.widgets.sessionchecker.shared.SessionInfoBean;
import com.google.gwt.core.client.GWT;
import com.google.gwt.dom.client.Style.Display;
import com.google.gwt.event.shared.HandlerManager;
import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.rpc.AsyncCallback;
import com.google.gwt.user.client.ui.HTML;
import com.google.gwt.user.client.ui.HasAlignment;
import com.google.gwt.user.client.ui.RootPanel;
import com.google.gwt.user.client.ui.VerticalPanel;
@Deprecated
public class CheckSession {
private final int MILLI_SECONDS = 55 * 1000; //(milli)seconds
//for css and images
private static CheckSessionBundle images = GWT.create(CheckSessionBundle.class);
static {
CheckSessionBundle.INSTANCE.css().ensureInjected();
}
/**
* the eventbus where to launch the events
*/
private HandlerManager eventBus = null;
/**
* Create a remote service proxy to talk to the server-side Greeting service.
*/
private final SessionCheckerServiceAsync checkerService = GWT.create(SessionCheckerService.class);
private String username;
private String scope;
private Timer t;
//we give the user the possibility to show the dialog or not
private boolean showSessionExpiredDialog = true;
//needed to mask the page when session id up!
private Div maskDiv = new Div();
private static CheckSession singleton;
/**
* use this method if you want to get an event when session expires
* @param eventBus your GWT webapp instance of {@link HandlerManager}
*/
public static CheckSession getInstance(HandlerManager eventBus) {
if (singleton == null)
singleton = new CheckSession(eventBus);
return singleton;
}
/**
* method with no events launching when session expires
*/
public static CheckSession getInstance() {
if (singleton == null)
singleton = new CheckSession();
return singleton;
}
/**
* use this constructor if you want to get an event when session expires
* @param eventBus GWT webapp instance of {@link HandlerManager}
*/
private CheckSession(HandlerManager eventBus) {
this();
this.eventBus = eventBus;
}
/**
* constructor with no events launching when session expires
*/
private CheckSession() {
addMaskDiv2DOM();
maskDiv.setStyleName("div-mask");
//polling timer
t = new Timer() {
@Override
public void run() {
checkerService.checkSession(new AsyncCallback<SessionInfoBean>() {
@Override
public void onSuccess(SessionInfoBean result) {
if (result != null) {
username = result.getUsername();
scope = result.getScope();
boolean userValid = ( username != null) ? true : false;
boolean scopeValid = (scope != null) ? true : false;
if (! (userValid && scopeValid) ) { //if session expired
mask(true);
stopPolling();
if (showSessionExpiredDialog) {
showLogoutDialog();
} else {
if (eventBus == null)
throw new NullPointerException("Hey, it seems you chose to handle yourself session expiration "
+ "but also not to get informed about it (eventbus is null) what's the point then?");
}
if (eventBus != null) {
eventBus.fireEvent(new SessionTimeoutEvent(result));
}
}
else if (result.isDevMode()) {
GWT.log("Stopping polling because i think you're in development mode and not in a real portal");
stopPolling();
}
}
else {
GWT.log("result null");
stopPolling();
}
}
@Override
public void onFailure(Throwable caught) {
mask(true);
stopPolling();
showLogoutDialog();
}
});
}
};
}
private void addMaskDiv2DOM() {
RootPanel.get().insert(maskDiv, 0);
}
/**
* set visible the masking div setting/unsetting css display property
* @param mask
*/
private void mask(boolean mask) {
GWT.log("Masking");
if (mask)
maskDiv.getElement().getStyle().setDisplay(Display.BLOCK);
else
maskDiv.getElement().getStyle().setDisplay(Display.NONE);
}
/**
* shows the logout dialog
*/
public static void showLogoutDialog() {
showLogoutDialog(null);
}
/**
* shows the logout dialog with redirection appended with parametersMap
* @param paramsMap a map containing the attrs and related values of what you want after the ?
* e.g. aUrl?name=foo&lastname=fie
*/
public static void showLogoutDialog(HashMap<String, String> paramsMap) {
String href = "javascript:location.reload();";
String params = "?";
if (! (paramsMap == null || paramsMap.isEmpty()) ) {
for (String attr : paramsMap.keySet()) {
params += attr+"="+paramsMap.get(attr)+"&";
}
href = Window.Location.getHref();
if (Window.Location.getHref().contains("?"))
href = href.substring(0, href.indexOf("?"));
href += params;
}
GCubeDialog dlg = new GCubeDialog();
dlg.setText("Your Session Expired!");
VerticalPanel topPanel = new VerticalPanel();
topPanel.setPixelSize(420, 290);
topPanel.setHorizontalAlignment(HasAlignment.ALIGN_CENTER);
HTML toShow = new HTML("<div style=\"margin-top: 40px;\">"
+ "<img style=\"margin: 0; vertical-align: middle; \" src='" + images.expired().getSafeUri().asString() + "'>"
+ "</div><div style=\"font-size: 18px; height: 20px; padding-top: 20px;\">"
+ "Please try <a href=\""+href+"\">reload</a> this page or <a href=\"/c/portal/logout\">logout</div>");
topPanel.add(toShow);
dlg.add(topPanel);
dlg.center();
dlg.show();
}
public String getUsername() {
return username;
}
public String getScope() {
return scope;
}
/**
* use to start checking if the session expired
*/
public void startPolling() {
t.scheduleRepeating(MILLI_SECONDS);
}
/**
* use to stop checking if the session expired
*/
public void stopPolling() {
t.cancel();
}
public boolean isShowSessionExpiredDialog() {
return showSessionExpiredDialog;
}
public void setShowSessionExpiredDialog(boolean showSessionExpiredDialog) {
this.showSessionExpiredDialog = showSessionExpiredDialog;
}
}

View File

@ -1,13 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.client;
import com.google.gwt.core.client.EntryPoint;
/**
* Entry point classes define <code>onModuleLoad()</code>.
*/
public class SessionChecker implements EntryPoint {
public void onModuleLoad() {
//CheckSession.getInstance().startPolling();
}
}

View File

@ -1,14 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.client;
import org.gcube.portlets.widgets.sessionchecker.shared.SessionInfoBean;
import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
/**
* The client side stub for the RPC service.
*/
@RemoteServiceRelativePath("checksession")
public interface SessionCheckerService extends RemoteService {
SessionInfoBean checkSession();
}

View File

@ -1,11 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.client;
import org.gcube.portlets.widgets.sessionchecker.shared.SessionInfoBean;
import com.google.gwt.user.client.rpc.AsyncCallback;
public interface SessionCheckerServiceAsync {
void checkSession(AsyncCallback<SessionInfoBean> callback);
}

View File

@ -1,11 +0,0 @@
@external div-mask;
.div-mask {
position: fixed;
width: 100%;
height: 100%;
background-color: rgba(0,0,0,.2);
top: 0;
left: 0;
display: none;
}

View File

@ -1,17 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.client.bundle;
import com.google.gwt.core.client.GWT;
import com.google.gwt.resources.client.ClientBundle;
import com.google.gwt.resources.client.CssResource;
import com.google.gwt.resources.client.ImageResource;
public interface CheckSessionBundle extends ClientBundle {
public static final CheckSessionBundle INSTANCE = GWT.create(CheckSessionBundle.class);
@Source("CheckSession.css")
public CssResource css();
@Source("session_expired.jpg")
ImageResource expired();
}

View File

@ -1,27 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.client.elements;
import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.ui.HTML;
import com.google.gwt.user.client.ui.HasText;
/**
*
* @author Massimiliano Assante, ISTI-CNR
* @version 0.1 Sep 2012
*
*/
public class Div extends HTML implements HasText {
public Div() {
super(DOM.createElement("div"));
}
public Div(String text) {
this();
setText(text);
}
public void setAttribute(String name, String value) {
super.getElement().setAttribute(name, value);
}
}

View File

@ -1,31 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.client.event;
import org.gcube.portlets.widgets.sessionchecker.shared.SessionInfoBean;
import com.google.gwt.event.shared.GwtEvent;
public class SessionTimeoutEvent extends GwtEvent<SessionTimoutEventHandler> {
public static Type<SessionTimoutEventHandler> TYPE = new Type<SessionTimoutEventHandler>();
private SessionInfoBean sessionInfo;
public SessionTimeoutEvent(SessionInfoBean sessionInfo) {
this.sessionInfo = sessionInfo;
}
public SessionInfoBean getSessionInfo() {
return sessionInfo;
}
@Override
public Type<SessionTimoutEventHandler> getAssociatedType() {
return TYPE;
}
@Override
protected void dispatch(SessionTimoutEventHandler handler) {
handler.onSessionExpiration(this);
}
}

View File

@ -1,7 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.client.event;
import com.google.gwt.event.shared.EventHandler;
public interface SessionTimoutEventHandler extends EventHandler {
void onSessionExpiration(SessionTimeoutEvent event);
}

View File

@ -1,100 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.server;
import java.util.Date;
import org.gcube.application.framework.core.session.ASLSession;
import org.gcube.application.framework.core.session.SessionManager;
import org.gcube.portal.custom.scopemanager.scopehelper.ScopeHelper;
import org.gcube.portlets.widgets.sessionchecker.client.SessionCheckerService;
import org.gcube.portlets.widgets.sessionchecker.shared.SessionInfoBean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.gwt.user.server.rpc.RemoteServiceServlet;
import com.liferay.portal.service.UserLocalServiceUtil;
/**
* The server side implementation of the RPC service.
*/
@SuppressWarnings("serial")
@Deprecated
public class SessionCheckerServiceImpl extends RemoteServiceServlet implements SessionCheckerService {
private static final Logger _log = LoggerFactory.getLogger(SessionCheckerServiceImpl.class);
/**
* the current ASLSession
* @return .
*/
private ASLSession getASLSession() {
String sessionID = this.getThreadLocalRequest().getSession().getId();
String user = (String) this.getThreadLocalRequest().getSession().getAttribute(ScopeHelper.USERNAME_ATTRIBUTE);
SessionManager manager = SessionManager.getInstance();
ASLSession toReturn = manager.getASLSession(sessionID, user);
return toReturn;
}
@Override
public SessionInfoBean checkSession() {
SessionManager manager = null;
try {
manager = SessionManager.getInstance();
}
catch (NullPointerException e) {
_log.error("SessionManager#getInstance null returning session expired");
return new SessionInfoBean("",""); //tells session expired
}
if (manager == null) {
_log.warn("Liferay Portal Detected but session Expired");
return new SessionInfoBean("",""); //tells session expired
}
ASLSession session = null;
try {
session = getASLSession();
if (session == null || session.getUsername() == null) {
UserLocalServiceUtil.getService();
_log.warn("Liferay Portal Detected but session Expired");
return new SessionInfoBean(null,null); //tells session expired
}
}
catch (Exception e) {
if (isWithinPortal()) {
_log.warn("Liferay Portal Detected but session Expired");
return new SessionInfoBean(null,null); //tells session expired
}
else {
_log.warn("Stopping session polling as i think you are in development mode");
return new SessionInfoBean("","", true); //tells that you are in development mode
}
}
String user = session.getUsername();
String scope = session.getScope();
//else
_log.trace("Session check OK for " + user + " at " + new Date());
if (user == null || user.compareTo("") == 0) {
_log.warn("User is null at " + new Date());
}
if (scope == null || scope.compareTo("") == 0) {
_log.warn("Scope is null at " + new Date());
}
return new SessionInfoBean(session.getUsername(), session.getScope());
}
/**
*
* @return true if you're running into the portal, false if in development
*/
private boolean isWithinPortal() {
try {
UserLocalServiceUtil.getService();
return true;
}
catch (com.liferay.portal.kernel.bean.BeanLocatorException ex) {
_log.trace("Development Mode ON");
return false;
}
}
}

View File

@ -1,63 +0,0 @@
package org.gcube.portlets.widgets.sessionchecker.shared;
import java.io.Serializable;
@SuppressWarnings("serial")
public class SessionInfoBean implements Serializable {
private String username;
private String scope;
private boolean isDevMode;
public SessionInfoBean() {
super();
}
public SessionInfoBean(String username, String scope) {
super();
this.username = username;
this.scope = scope;
}
public SessionInfoBean(String username, String scope, boolean isDevMode) {
super();
this.username = username;
this.scope = scope;
this.isDevMode = isDevMode;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getScope() {
return scope;
}
public void setScope(String scope) {
this.scope = scope;
}
public boolean isDevMode() {
return isDevMode;
}
public void setDevMode(boolean isDevMode) {
this.isDevMode = isDevMode;
}
}

View File

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry including="**/*.java" kind="src" output="${webappDirectory}/WEB-INF/classes" path="src/main/java">
<classpathentry including="**/*.java" kind="src" output="target/classes" path="src/main/java">
<attributes>
<attribute name="optional" value="true"/>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry excluding="**" kind="src" output="${webappDirectory}/WEB-INF/classes" path="src/main/resources">
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
@ -15,11 +15,7 @@
<attributes>
<attribute name="optional" value="true"/>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
<attributes>
<attribute name="maven.pomderived" value="true"/>
<attribute name="test" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="com.google.gwt.eclipse.core.GWT_CONTAINER"/>
@ -43,5 +39,5 @@
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="output" path="${webappDirectory}/WEB-INF/classes"/>
<classpathentry kind="output" path="target/classes"/>
</classpath>

View File

@ -3,6 +3,9 @@ org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.7
org.eclipse.jdt.core.compiler.compliance=1.7
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=ignore
org.eclipse.jdt.core.compiler.release=disabled
org.eclipse.jdt.core.compiler.source=1.7