UP-4179: uPortal 5 project overhault with a Gradle-based build

build.xml

@@ -727,6 +727,20 @@
     <!-- ================================ Internal Targets ================================ -->
     <!--                                                                                    -->
 
+    <!-- Internal use -->
+    <target name="gradle-install" description="Build and install (in maven local) the uPortal modules that have been ported to a Gradle-based build">
+        <!--
+         | TEMPORARY MEASURE!
+         |
+         | uPortal is moving from Ant/Maven to Gradle.  We are porting sources bit by bit.
+         | Once we can remove Maven, we can remove this target too.
+         +-->
+        <exec executable="./gradlew">
+            <arg value="clean"/>
+            <arg value="install"/>
+        </exec>
+    </target>
+
     <!-- Internal use -->
     <target name="db-ddl" depends="prodPrompt" description="Create a SQL script of commands to drop and create the uPortal database without executing them.">
         <fail unless="ddlFile">
@@ -1575,6 +1589,7 @@ IMPORTANT: The '-Dpattern=' property is no longer a regular expression and is a
         <element name="war-sub-tasks" optional="false" implicit="true" />
 
         <sequential>
+            <antcall target="gradle-install" />
             <uportal-db-macro>
                 <fileset id="uportal-parent.pom.fsid" file="${basedir}/pom.xml" />
             </uportal-db-macro>

pom.xml

@@ -157,7 +157,7 @@
         <commons-dbcp.version>1.4</commons-dbcp.version>
         <commons-fileupload.version>1.3.1</commons-fileupload.version>
         <commons-httpclient.version>3.1</commons-httpclient.version>
-        <commons-httpcomponents.version>4.3.2</commons-httpcomponents.version>
+        <commons-httpcomponents.version>4.4.4</commons-httpcomponents.version>
         <commons-io.version>2.4</commons-io.version>
         <commons-lang.version>2.6</commons-lang.version>
         <commons-lang3.version>3.3.2</commons-lang3.version>

uportal-war/pom.xml

@@ -33,7 +33,7 @@
 
     <name>uPortal WAR</name>
     <description>The uPortal web application.</description>
-    
+
     <dependencies>
         <!-- ***** Portal JDBC Driver ***** -->
         <dependency>
@@ -42,13 +42,31 @@
             <version>${project.version}</version>
             <type>pom</type>
         </dependency>
-
+
+        <!-- ===== uPortal Dependencies ======================================= -->
+        <dependency>
+            <groupId>org.jasig.portal</groupId>
+            <artifactId>uportal-platform-api</artifactId>
+            <version>${project.version}</version>
+            <scope>provided</scope>
+        </dependency>
         <dependency>
             <groupId>org.jasig.portal</groupId>
             <artifactId>uportal-search-api</artifactId>
             <version>${project.version}</version>
         </dependency>
-
+        <dependency>
+            <groupId>org.jasig.portal</groupId>
+            <artifactId>uPortal-soffit-connector</artifactId>
+            <version>${project.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+
         <!-- ===== Compile Dependencies ======================================= -->
         <dependency>
             <groupId>org.antlr</groupId>
@@ -552,13 +570,6 @@
             <scope>provided</scope>
         </dependency>
 
-        <dependency>
-            <groupId>org.jasig.portal</groupId>
-            <artifactId>uportal-platform-api</artifactId>
-            <version>${project.version}</version>
-            <scope>provided</scope>
-        </dependency>
-
         <!-- ===== Runtime Dependencies ======================================= -->
 
         <dependency>

uportal-war/src/main/java/org/jasig/portal/soffit/AuthorizationHeaderProvider.java

@@ -0,0 +1,113 @@
+/**
+ * Licensed to Apereo under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work
+ * for additional information regarding copyright ownership.
+ * Apereo licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License.  You may obtain a
+ * copy of the License at the following location:
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.jasig.portal.soffit;
+
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.Map.Entry;
+
+import javax.portlet.PortletSession;
+import javax.portlet.RenderRequest;
+import javax.portlet.RenderResponse;
+
+import org.apache.http.Header;
+import org.apache.http.message.BasicHeader;
+import org.apereo.portal.soffit.Headers;
+import org.apereo.portal.soffit.connector.AbstractHeaderProvider;
+import org.apereo.portal.soffit.model.v1_0.Bearer;
+import org.apereo.portal.soffit.service.BearerService;
+import org.jasig.portal.groups.IEntityGroup;
+import org.jasig.portal.groups.IGroupMember;
+import org.jasig.portal.security.IPerson;
+import org.jasig.portal.services.GroupService;
+import org.jasig.services.persondir.IPersonAttributeDao;
+import org.jasig.services.persondir.IPersonAttributes;
+import org.springframework.beans.factory.annotation.Autowired;
+
+/**
+ * Prepares the standard HTTP Authorization header.  This component is defined
+ * explicitly in the portlet context (not by annotation).
+ *
+ * @since 5.0
+ * @author drewwills
+ */
+public class AuthorizationHeaderProvider extends AbstractHeaderProvider {
+
+    @Autowired
+    private IPersonAttributeDao personAttributeDao;
+
+    @Autowired
+    private BearerService bearerService;
+
+    @Override
+    public Header createHeader(RenderRequest renderRequest, RenderResponse renderResponse) {
+
+        // Username
+        final String username = getUsername(renderRequest);
+
+        // Attributes
+        final Map<String,List<String>> attributes = new HashMap<>();
+        final IPersonAttributes person = personAttributeDao.getPerson(username);
+        if (person != null) {
+            for (Entry<String, List<Object>> y : person.getAttributes().entrySet()) {
+                final List<String> values = new ArrayList<>();
+                for (Object value : y.getValue()) {
+                    if (value instanceof String) {
+                        values.add((String) value);
+                    }
+                }
+                attributes.put(y.getKey(), values);
+            }
+        }
+        logger.debug("Found the following user attributes for username='{}':  {}", username, attributes);
+
+        // Groups
+        final List<String> groups = new ArrayList<>();
+        final IGroupMember groupMember = GroupService.getGroupMember(username, IPerson.class);
+        if (groupMember != null) {
+            Set<IEntityGroup> ancestors = groupMember.getAncestorGroups();
+            for (IEntityGroup g : ancestors) {
+                groups.add(g.getName());
+            }
+        }
+        logger.debug("Found the following group affiliations for username='{}':  {}", username, groups);
+
+        // Expiration of the Bearer token
+        final PortletSession portletSession = renderRequest.getPortletSession();
+        final Date expires = new Date(
+                    portletSession.getLastAccessedTime() + ((long) portletSession.getMaxInactiveInterval() * 1000L)
+                );
+
+        // Authorization header
+        final Bearer bearer = bearerService.createBearer(username, attributes, groups, expires);
+        final Header rslt = new BasicHeader(
+                Headers.AUTHORIZATION.getName(),
+                Headers.BEARER_TOKEN_PREFIX + bearer.getEncryptedToken());
+        logger.debug("Produced the following Authorization header for username='{}':  {}", username, rslt);
+
+        return rslt;
+
+    }
+
+}

uportal-war/src/main/java/org/jasig/portal/soffit/DefinitionHeaderProvider.java

@@ -0,0 +1,140 @@
+/**
+ * Licensed to Apereo under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work
+ * for additional information regarding copyright ownership.
+ * Apereo licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License.  You may obtain a
+ * copy of the License at the following location:
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.jasig.portal.soffit;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+
+import javax.portlet.RenderRequest;
+import javax.portlet.RenderResponse;
+import javax.servlet.http.HttpServletRequest;
+
+import org.apache.http.Header;
+import org.apache.http.message.BasicHeader;
+import org.apereo.portal.soffit.Headers;
+import org.apereo.portal.soffit.connector.AbstractHeaderProvider;
+import org.apereo.portal.soffit.model.v1_0.Definition;
+import org.apereo.portal.soffit.service.DefinitionService;
+import org.jasig.portal.i18n.ILocaleStore;
+import org.jasig.portal.i18n.LocaleManager;
+import org.jasig.portal.portlet.marketplace.IMarketplaceService;
+import org.jasig.portal.portlet.marketplace.MarketplacePortletDefinition;
+import org.jasig.portal.portlet.om.IPortletDefinition;
+import org.jasig.portal.portlet.om.IPortletDefinitionParameter;
+import org.jasig.portal.portlet.om.IPortletWindow;
+import org.jasig.portal.portlet.om.IPortletWindowId;
+import org.jasig.portal.portlet.om.PortletCategory;
+import org.jasig.portal.portlet.registry.IPortletWindowRegistry;
+import org.jasig.portal.security.IPerson;
+import org.jasig.portal.security.IPersonManager;
+import org.jasig.portal.url.IPortalRequestUtils;
+import org.springframework.beans.factory.annotation.Autowired;
+
+/**
+ * Prepares the custom HTTP X-Soffit-Definition header.  This component is
+ * defined explicitly in the portlet context (not by annotation).
+ *
+ * @since 5.0
+ * @author drewwills
+ */
+public class DefinitionHeaderProvider extends AbstractHeaderProvider {
+
+    @Autowired
+    private IPortalRequestUtils portalRequestUtils;
+
+    @Autowired
+    private IPortletWindowRegistry portletWindowRegistry;
+
+    @Autowired
+    private IMarketplaceService marketplaceService;
+
+    @Autowired
+    private IPersonManager personManager;
+
+    @Autowired
+    private ILocaleStore localeStore;
+
+    @Autowired
+    private DefinitionService definitionService;
+
+    @Override
+    public Header createHeader(RenderRequest renderRequest, RenderResponse renderResponse) {
+
+        // Username
+        final String username = getUsername(renderRequest);
+
+        // Obtain the MarketplacePortletDefinition for this soffit
+        final HttpServletRequest httpr = portalRequestUtils.getCurrentPortalRequest();
+        final IPortletWindowId portletWindowId = portletWindowRegistry.getPortletWindowId(httpr, renderRequest.getWindowID());
+        final IPortletWindow portletWindow = portletWindowRegistry.getPortletWindow(httpr, portletWindowId);
+        final IPortletDefinition pdef = portletWindow.getPortletEntity().getPortletDefinition();
+        final MarketplacePortletDefinition mpdef = this.marketplaceService.getOrCreateMarketplacePortletDefinition(pdef);
+
+        final IPerson user = personManager.getPerson(httpr);
+        final Locale locale = getUserLocale(user);
+
+        // Title
+        final String title = mpdef.getTitle(locale.toString());
+
+        // FName
+        final String fname = mpdef.getFName();
+
+        // Description
+        final String description = mpdef.getDescription(locale.toString());
+
+        // Categories
+        List<String> categories = new ArrayList<>();
+        for (PortletCategory pc : mpdef.getCategories()) {
+            categories.add(pc.getName());
+        }
+
+        // Parameters
+        Map<String,List<String>> parameters = new HashMap<>();
+        for (IPortletDefinitionParameter param : mpdef.getParameters()) {
+            parameters.put(param.getName(), Collections.singletonList(param.getValue()));
+        }
+
+        final Definition definition = definitionService.createDefinition(title, fname,
+                description, categories, parameters, username, getExpiration(renderRequest));
+        final Header rslt = new BasicHeader(
+                Headers.DEFINITION.getName(),
+                definition.getEncryptedToken());
+        logger.debug("Produced the following {} header for username='{}':  {}", Headers.DEFINITION.getName(), username, rslt);
+
+        return rslt;
+    }
+
+    /*
+     * Implementation
+     */
+
+    private Locale getUserLocale(IPerson user) {
+        // get user locale
+        Locale[] locales = localeStore.getUserLocales(user);
+        LocaleManager localeManager = new LocaleManager(user, locales);
+        Locale rslt = localeManager.getLocales()[0];
+        return rslt;
+    }
+
+}

uportal-war/src/main/resources/properties/ehcache.xml

@@ -2066,4 +2066,14 @@
            eternal="false" maxElementsInMemory="2000" overflowToDisk="false" diskPersistent="false"
            timeToIdleSeconds="0" timeToLiveSeconds="300" memoryStoreEvictionPolicy="LRU" statistics="true" />
 
+    <!-- 
+     | Caches out output of remote soffits;  timeToLiveSeconds will be set on
+     | each Element according to the cache-control header send by the remote soffit.
+     | - 1 x unique combination of (soffit+mode+windowState) [x user for private scope] 
+     | - not replicated
+     +-->
+    <cache name="org.apereo.portlet.soffit.connector.SoffitConnectorController.RESPONSE_CACHE"
+        eternal="false" maxElementsInMemory="2000" overflowToDisk="false" diskPersistent="false"
+        timeToIdleSeconds="0" timeToLiveSeconds="0" memoryStoreEvictionPolicy="LRU" statistics="true" />
+
 </ehcache>

uportal-war/src/main/resources/properties/portal.properties

@@ -776,4 +776,18 @@ org.jasig.portal.tincan-api.enabled=false
 # org.jasig.rest.interceptor.basic-auth.scorm-cloud-lrs.username=UsernameForProvider
 # org.jasig.rest.interceptor.basic-auth.scorm-cloud-lrs.password=PasswordForProvider
 
+# Signature Key (Soffit)
+# ----------------------
+# Uncomment and change the value of this setting.  'CHANGEME' is the default
+# value;  it may work (if both sides of the transaction have the default), but
+# isn't secure and will produce a WARNING.
+#
+#org.apereo.portal.soffit.jwt.signatureKey=CHANGEME
 
+# Encryption Password (Soffit)
+# ----------------------------
+# Uncomment and change the value of this setting.  'CHANGEME' is the default
+# value;  it may work (if both sides of the transaction have the default), but
+# isn't secure and will produce a WARNING.
+#
+#org.apereo.portal.soffit.jwt.encryptionPassword=CHANGEME