init

.blade.properties

@@ -0,0 +1,3 @@
+#Wed Jan 13 21:43:53 GST 2021
+liferay.version.default=7.3
+profile.name=gradle

.gitignore

@@ -0,0 +1,26 @@
+**/*.iml
+**/.ivy
+**/.classpath
+**/.project
+**/.sass-cache
+**/.settings
+**/bin
+**/build
+**/build_gradle
+**/node_modules
+**/test-coverage
+**/tmp
+**/.web_bundle_build
+.gradle
+.idea
+.DS_Store
+/bundles
+/gradle-*.properties
+/plugins-sdk/**/classes
+/plugins-sdk/**/ivy.xml.MD5
+/plugins-sdk/**/liferay-hook.xml.processed
+/plugins-sdk/build.*.properties
+/plugins-sdk/dependencies/**/*.jar
+/plugins-sdk/dist
+/plugins-sdk/lib
+test-results

README.md

@@ -0,0 +1,86 @@
+# Article Service Template Context Contributor
+
+Developed against Liferay DXP 7.3, 7.2
+
+Built with [Liferay Workspace](https://help.liferay.com/hc/en-us/articles/360029147471-Liferay-Workspace) and [Blade CLI](https://help.liferay.com/hc/en-us/articles/360029147071-Blade-CLI).
+
+## Usage
+
+Follow the steps below to build and deploy or copy the modules from the [releases](/releases/latest) page to your Liferay's deploy folder.
+
+The "Article Service Template Context Contributor" makes a `articleService` object available in your freemarker templates. This object exposes a number of different methods to let you easily get the rendered content of a web content article.
+
+The following methods are available.
+
+| Methods                                                           |
+| ----------------------------------------------------------------- |
+| getContentByClassPK(long classPK)                                 |
+| getContentByClassPK(long classPK, String ddmTemplateKey)          |
+| getContentByPrimaryKey(String primaryKey)                         |
+| getContentByPrimaryKey(String primaryKey, String ddmTemplateKey)  |
+
+## Purpose
+
+It's common when using Liferay to want to change how web content is rendered inside of an asset publisher. Liferay makes this possible by creating a new Application Display Template or ADT for your asset publisher. When using an ADT if you want to get the web contents rendered content this could be done using the `serviceLocator` to access Liferay's `JournalArticleLocalService`. `serviceLocator` had to be enabled via the control panel, which isn't necessarily best to make globally available since it can access any Liferay service. With serviceLocator the content could be rendered like so:
+
+```
+<#if serviceLocator??>
+	<#if className == "com.liferay.journal.model.JournalArticle">
+		<#assign journalArticle = assetRenderer.getArticle() />
+		<#assign JournalArticleLocalService = serviceLocator.findService("com.liferay.journal.service.JournalArticleLocalService") />
+
+		<#assign content = JournalArticleLocalService.getArticleContent(journalArticle, "{templateID}", "view", themeDisplay.getLocale().toString(), themeDisplay) />
+
+		${content}
+	</#if>
+</#if>
+```
+
+Alternatively, this module creates a [Template Context Contributor](https://help.liferay.com/hc/en-us/articles/360029006112-Template-Context-Contributor) that provides access to a few simplified methods for rendering web content. This keeps you from needing to expose serviceLocator and also simplifies the api, removing the need to pass large object like themeDisplay. 
+
+### Example Usage in a Web Content Template
+
+Web content structures allow you to select "Web Content" as a field type. When this is selected you can access and render the web content using the following method.
+
+```
+<#assign webContentData = jsonFactoryUtil.createJSONObject(WebContent19m8.getData())/>
+
+// Render with the default template
+${articleService.getContentByClassPK(webContentData.classPK?number)}
+
+// Optionally pass the ddmTemplateKey
+${articleService.getContentByClassPK(webContentData.classPK?number, "12345")}
+```
+
+### Example Usage in an Asset Publisher Template
+
+```
+<#if entries?has_content>
+    <div class="d-flex flex-wrap">
+    	<#list entries as curEntry>
+    	    <div class="w-25 flex-shrink-0 p-3">
+        		${articleService.getContentByClassPK(curEntry.getClassPK()?number)}
+        	</div>
+    	</#list>
+    </div>
+</#if>
+```
+
+## How to Build and Deploy to Liferay
+
+In order to build or deploy this module you will need to [install Blade CLI](https://help.liferay.com/hc/en-us/articles/360028833852-Installing-Blade-CLI).
+
+### To Build
+
+`$ blade gw build`
+
+You can find the built modules at `modules/{module-name}/build/libs/{module-name}.jar`.
+
+### To Deploy
+
+In `gradle-local.properties` add the following line to point towards the Liferay instance you want to deploy to:
+```
+liferay.workspace.home.dir=/path/to/liferay/home
+```
+
+## Issues & Questions Welcome

configs/dev/portal-ext.properties

@@ -0,0 +1,9 @@
+include-and-override=portal-developer.properties
+
+#
+# MySQL
+#
+#jdbc.default.driverClassName=com.mysql.cj.jdbc.Driver
+#jdbc.default.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false
+#jdbc.default.username=root
+#jdbc.default.password=

configs/local/portal-ext.properties

@@ -0,0 +1,9 @@
+include-and-override=portal-developer.properties
+
+#
+# MySQL
+#
+#jdbc.default.driverClassName=com.mysql.cj.jdbc.Driver
+#jdbc.default.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false
+#jdbc.default.username=root
+#jdbc.default.password=

configs/prod/osgi/configs/com.liferay.portal.search.elasticsearch.configuration.ElasticsearchConfiguration.config

@@ -0,0 +1,2 @@
+operationMode="REMOTE"
+transportAddresses=["127.0.0.1:9300"]

configs/prod/portal-ext.properties

@@ -0,0 +1,7 @@
+#
+# MySQL
+#
+#jdbc.default.driverClassName=com.mysql.cj.jdbc.Driver
+#jdbc.default.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false
+#jdbc.default.username=root
+#jdbc.default.password=

configs/uat/osgi/configs/com.liferay.portal.search.elasticsearch.configuration.ElasticsearchConfiguration.config

@@ -0,0 +1,3 @@
+logExceptionsOnly=B"false"
+operationMode="REMOTE"
+transportAddresses=["127.0.0.1:9300"]

configs/uat/portal-ext.properties

@@ -0,0 +1,7 @@
+#
+# MySQL
+#
+#jdbc.default.driverClassName=com.mysql.cj.jdbc.Driver
+#jdbc.default.url=jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false
+#jdbc.default.username=root
+#jdbc.default.password=

gradle.properties

@@ -0,0 +1,3 @@
+liferay.workspace.modules.dir=modules
+liferay.workspace.product=dxp-7.3-ga1
+microsoft.translator.subscription.key=

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -0,0 +1,188 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed 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
+#
+#      https://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.
+#
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"