diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..bc54a72 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,54 @@ +# Declare text files with unix file ending +*.conf text eol=lf +*.config text eol=lf +*.css text eol=lf +*.dtd text eol=lf +*.esp text eol=lf +*.ecma text eol=lf +*.groovy text eol=lf +*.hbrs text eol=lf +*.hbs text eol=lf +*.htm text eol=lf +*.html text eol=lf +*.java text eol=lf +*.jpage text eol=lf +*.js text eol=lf +*.json text eol=lf +*.jsp text eol=lf +*.mustache text eol=lf +*.tld text eol=lf +*.launch text eol=lf +*.log text eol=lf +*.php text eol=lf +*.pl text eol=lf +*.project text eol=lf +*.properties text eol=lf +*.props text eol=lf +*.sass text eol=lf +*.scss text eol=lf +*.sh text eol=lf +*.shtm text eol=lf +*.shtml text eol=lf +*.sql text eol=lf +*.svg text eol=lf +*.txt text eol=lf +*.vm text eol=lf +*.xml text eol=lf +*.xsd text eol=lf +*.xsl text eol=lf +*.xslt text eol=lf +*.yml text eol=lf +*.yaml text eol=lf + + +# Declare windows-specific text files with windows file ending +*.asp text eol=crlf +*.asax text eol=crlf +*.asa text eol=crlf +*.aspx text eol=crlf +*.bat text eol=crlf +*.cmd text eol=crlf +*.cs text eol=crlf +*.csproj text eol=crlf +*.reg text eol=crlf +*.sln text eol=crlf diff --git a/.github/workflows/maven-build.yml b/.github/workflows/maven-build.yml new file mode 100644 index 0000000..fc4f02d --- /dev/null +++ b/.github/workflows/maven-build.yml @@ -0,0 +1,37 @@ +# Build validation + +name: Build + +on: + push: + branches-ignore: + - master + - experimental/** + pull_request: + types: [opened, synchronize, reopened] + branches-ignore: + - master + - experimental/** + workflow_dispatch: + +jobs: + build: + + runs-on: ${{ matrix.os }} + strategy: + matrix: + java: [11, 17, 21] + os: [ubuntu-latest] + distribution: [temurin] + + steps: + - name: Maven Build with SonarCloud + uses: wcm-io-devops/github-action-maven-build-sonar@v1 + with: + os: ${{ matrix.os }} + java-version: ${{ matrix.java }} + maven-executable: ./mvnw + sonar-run-on-os: ubuntu-latest + sonar-run-on-java-version: 17 + sonar-token: ${{ secrets.SONAR_TOKEN }} + github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/maven-deploy.yml b/.github/workflows/maven-deploy.yml new file mode 100644 index 0000000..c709b1c --- /dev/null +++ b/.github/workflows/maven-deploy.yml @@ -0,0 +1,45 @@ +# Deploy snapshots to Sonatype OSS repository and deploy site to GitHub Pages + +name: Deploy + +concurrency: ${{ github.workflow }} + +on: + push: + branches: + - develop + workflow_dispatch: + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Configure GIT + run: | + git config --global user.email "${{ secrets.GH_SITE_DEPLOY_EMAIL }}" + git config --global user.name "${{ secrets.GH_SITE_DEPLOY_NAME }}" + + - name: Setup JDK + uses: actions/setup-java@v3 + with: + distribution: temurin + java-version: 11 + cache: maven + + - name: Build, verify, deploy, generate site + env: + SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }} + SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} + run: ./mvnw -s ./.maven-settings.xml -Pcontinuous-integration -B -U clean deploy site + + - name: Stage and deploy site + run: > + ./mvnw -s ./.maven-settings.xml -Pcontinuous-integration -B site:stage scm-publish:publish-scm + -Dscmpublish.checkinComment="Maven site: ${{ github.repository }}" + -Dusername=${{ secrets.GH_SITE_DEPLOY_USERNAME }} + -Dpassword=${{ secrets.GH_SITE_DEPLOY_PAT }} diff --git a/.github/workflows/release-from-tag.yml b/.github/workflows/release-from-tag.yml new file mode 100644 index 0000000..b4a712c --- /dev/null +++ b/.github/workflows/release-from-tag.yml @@ -0,0 +1,19 @@ +name: Release from Tag + +on: + push: + tags: + - '*' + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + - uses: ncipollo/release-action@v1 + with: + body: 'Changes: https://wcm.io/wcm/ui/clientlibs/changes-report.html' + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..cb0de5f --- /dev/null +++ b/.gitignore @@ -0,0 +1,34 @@ +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +release.properties +maven-eclipse.xml +infinitest.filters + +node_modules/ +npm-debug.log + +.nodejs +.project +.classpath +.settings +.externalToolBuilders +.pmd +.eclipse-pmd +.checkstyle +.idea +.vagrant +*.iml +.DS_Store +*.retry +.rubygems +.sass-cache +.rubygems-gem-maven-plugin +*.sublime-* +*nbactions*.xml +.temp/ +.vlt +.vlt-sync* +.brackets.json diff --git a/.maven-settings.xml b/.maven-settings.xml new file mode 100644 index 0000000..fb12e79 --- /dev/null +++ b/.maven-settings.xml @@ -0,0 +1,132 @@ + + + + + + + + default + + + + + central + https://repo1.maven.org/maven2/ + default + + true + never + + + false + + + + + oss-snapshots + https://oss.sonatype.org/content/repositories/snapshots + default + + false + + + true + always + + + + + apache-snapshots + https://repository.apache.org/snapshots + default + + false + + + true + always + + + + + + + + + central + https://repo1.maven.org/maven2/ + default + + true + never + + + false + + + + + oss-snapshots + https://oss.sonatype.org/content/repositories/snapshots + default + + false + + + true + always + + + + + apache-snapshots + https://repository.apache.org/snapshots + default + + false + + + true + always + + + + + + + + + + + default + + + + + ossrh + ${env.SONATYPE_USERNAME} + ${env.SONATYPE_PASSWORD} + + + + diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..cb28b0e Binary files /dev/null and b/.mvn/wrapper/maven-wrapper.jar differ diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..ac18401 --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,18 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF 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 +# +# 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. +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.4/apache-maven-3.9.4-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5c304d1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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 + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f039c25 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ + WCM Clientlibs UI Extensions +====== +[![Build](https://github.com/wcm-io/io.wcm.wcm.ui.clientlibs/workflows/Build/badge.svg?branch=develop)](https://github.com/wcm-io/io.wcm.wcm.ui.clientlibs/actions?query=workflow%3ABuild+branch%3Adevelop) +[![Maven Central](https://img.shields.io/maven-central/v/io.wcm/io.wcm.wcm.ui.clientlibs)](https://repo1.maven.org/maven2/io/wcm/io.wcm.wcm.ui.clientlibs/) +[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=wcm-io_io.wcm.wcm.ui.clientlibs&metric=coverage)](https://sonarcloud.io/summary/new_code?id=wcm-io_io.wcm.wcm.ui.clientlibs) + +Extensions for AEM HTML client libraries. + +Documentation: https://wcm.io/wcm/ui/clientlibs/
+Issues: https://github.com/wcm-io/io.wcm.wcm.ui.clientlibs/issues
+Wiki: https://wcm-io.atlassian.net/wiki/
+Continuous Integration: https://github.com/wcm-io/io.wcm.wcm.ui.clientlibs/actions
+Commercial support: https://wcm.io/commercial-support.html + + +## Build from sources + +If you want to build wcm.io from sources make sure you have configured all [Maven Repositories](https://wcm.io/maven.html) in your settings.xml. + +See [Maven Settings](https://github.com/wcm-io/io.wcm.wcm.ui.clientlibs/blob/develop/.maven-settings.xml) for an example with a full configuration. + +Then you can build using + +``` +mvn clean install +``` diff --git a/changes.xml b/changes.xml index b47d019..8b5ca9a 100644 --- a/changes.xml +++ b/changes.xml @@ -23,6 +23,24 @@ xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd"> + + + Add optional support for rel=preload|prefetch for CSS includes. + + + All HTML attributes for JS and CSS includes are now rendered in alphabetically order. + + + Support custom attributes for CSS and JS includes. + + + Switch to Java 11 as minimum version. + + + Switch to AEM 6.5.7 as minimum version. + + + Add sling-initial-content-transform-maven-plugin to alternatively allow to deploy OSGi bundle and content as content package separately in AEMaaCS. diff --git a/mvnw b/mvnw new file mode 100755 index 0000000..8d937f4 --- /dev/null +++ b/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF 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 +# +# 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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + 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 + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000..c4586b5 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml index 7b098e4..5c4efef 100644 --- a/pom.xml +++ b/pom.xml @@ -24,14 +24,14 @@ io.wcm - io.wcm.wcm.parent - 1.4.8 - ../../parent/pom.xml + io.wcm.parent_toplevel + 2.2.4 + io.wcm io.wcm.wcm.ui.clientlibs - 1.2.2 + 1.3.0 jar WCM Clientlibs UI Extensions @@ -39,9 +39,9 @@ ${site.url}/${site.url.module.prefix}/ - scm:git:https://github.com/wcm-io/wcm-io-wcm.git - scm:git:https://github.com/wcm-io/wcm-io-wcm.git - https://github.com/wcm-io/wcm-io-wcm + scm:git:https://github.com/wcm-io/io.wcm.wcm.ui.clientlibs.git + scm:git:https://github.com/wcm-io/io.wcm.wcm.ui.clientlibs.git + https://github.com/wcm-io/io.wcm.wcm.ui.clientlibs HEAD @@ -49,7 +49,7 @@ wcm/ui/clientlibs - 2021-11-08T14:21:08Z + 2023-11-20T15:22:05Z @@ -94,7 +94,7 @@ io.wcm io.wcm.testing.aem-mock.junit5 - 4.0.2 + 5.0.0 test @@ -111,15 +111,8 @@ - org.slf4j - slf4j-api - compile - - - - - org.apache.geronimo.specs - geronimo-annotation_1.3_spec + com.adobe.aem + uber-jar provided @@ -159,13 +152,30 @@ + + org.apache.maven.plugins + maven-site-plugin + + ${site.deploy.url} + + + + + org.apache.maven.plugins + maven-scm-publish-plugin + + ${site.url.module.prefix} + true + + + ${site.deploy.id} - ${site.deploy.url}/${site.url.module.prefix} + ${site.deploy.url} diff --git a/src/main/java/io/wcm/wcm/ui/clientlibs/components/CSSInclude.java b/src/main/java/io/wcm/wcm/ui/clientlibs/components/CSSInclude.java index d6d9733..57ea21f 100644 --- a/src/main/java/io/wcm/wcm/ui/clientlibs/components/CSSInclude.java +++ b/src/main/java/io/wcm/wcm/ui/clientlibs/components/CSSInclude.java @@ -19,7 +19,10 @@ */ package io.wcm.wcm.ui.clientlibs.components; +import java.util.HashMap; import java.util.List; +import java.util.Map; +import java.util.Set; import javax.annotation.PostConstruct; @@ -45,6 +48,9 @@ @ProviderType public class CSSInclude { + private static final Set REL_ALLOWED_VALUES = Set.of( + "prefetch", "preload"); + @SlingObject private ResourceResolver resourceResolver; @OSGiService @@ -54,31 +60,62 @@ public class CSSInclude { @RequestAttribute(injectionStrategy = InjectionStrategy.OPTIONAL) private Object categories; + @RequestAttribute(injectionStrategy = InjectionStrategy.OPTIONAL) + private String rel; + @RequestAttribute(injectionStrategy = InjectionStrategy.OPTIONAL) + private Object customAttributes; private String include; @PostConstruct private void activate() { // build include string - String[] categoryArray = IncludeUtil.toCategoryArray(categories); + String[] categoryArray = IncludeUtil.toArray(categories); if (categoryArray != null) { List libraryPaths = IncludeUtil.getLibraryUrls(htmlLibraryManager, resourceResolver, categoryArray, LibraryType.CSS); if (!libraryPaths.isEmpty()) { - this.include = buildIncludeString(libraryPaths); + Map attrs = validateAndBuildAttributes(); + Map customAttrs = IncludeUtil.getCustomAttributes(customAttributes); + this.include = buildIncludeString(libraryPaths, attrs, customAttrs); } } } + /** + * Validate attribute values from HTL script, escape them properly and build a map with all attributes + * for the resulting script tag(s). + * @return Map with attribute for script tag + */ + private @NotNull Map validateAndBuildAttributes() { + Map attrs = new HashMap<>(); + if (rel != null && REL_ALLOWED_VALUES.contains(rel)) { + attrs.put("rel", rel); + } + else { + // no specific rel defined, provide default rel/type attrs for CSS + attrs.put("rel", "stylesheet"); + attrs.put("type", "text/css"); + } + return attrs; + } + /** * Build CSS link tags for all client libraries with the defined custom script tag attributes set. * @param libraryPaths Library paths + * @param attrs HTML attributes for link tag + * @param customAttrs Custom HTML attributes for script tag * @return HTML markup with script tags */ - private @NotNull String buildIncludeString(@NotNull List libraryPaths) { + private @NotNull String buildIncludeString(@NotNull List libraryPaths, @NotNull Map attrs, + @NotNull Map customAttrs) { StringBuilder markup = new StringBuilder(); for (String libraryPath : libraryPaths) { - markup.append("\n"); + HtmlTagBuilder builder = new HtmlTagBuilder("link", false, xssApi); + builder.setAttrs(attrs); + builder.setAttrs(customAttrs); + builder.setAttr("href", libraryPath); + markup.append(builder.build()); } return markup.toString(); } diff --git a/src/main/java/io/wcm/wcm/ui/clientlibs/components/HtmlTagBuilder.java b/src/main/java/io/wcm/wcm/ui/clientlibs/components/HtmlTagBuilder.java new file mode 100644 index 0000000..b5a0919 --- /dev/null +++ b/src/main/java/io/wcm/wcm/ui/clientlibs/components/HtmlTagBuilder.java @@ -0,0 +1,86 @@ +/* + * #%L + * wcm.io + * %% + * Copyright (C) 2023 wcm.io + * %% + * 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 + * + * 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. + * #L% + */ +package io.wcm.wcm.ui.clientlibs.components; + +import java.util.Map; +import java.util.TreeMap; + +import org.apache.sling.xss.XSSAPI; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +class HtmlTagBuilder { + + private final String tagName; + private final boolean closeTag; + private final XSSAPI xssApi; + private final Map attrs = new TreeMap<>(); + + /** + * @param tagName Tag name + * @param closeTag Add closing for HTML tag + * @param xssApi XSS API + */ + HtmlTagBuilder(@NotNull String tagName, boolean closeTag, @NotNull XSSAPI xssApi) { + this.tagName = tagName; + this.closeTag = closeTag; + this.xssApi = xssApi; + } + + /** + * Set HTML attributes + * @param attrs HTML attributes + */ + void setAttrs(Map attrs) { + this.attrs.putAll(attrs); + } + + /** + * Set HTML attribute + * @param name Name + * @param value Value or null + */ + void setAttr(@NotNull String name, @Nullable String value) { + this.attrs.put(name, value); + } + + /** + * @return HTML markup + */ + String build() { + StringBuilder markup = new StringBuilder(); + markup.append("<").append(tagName); + for (Map.Entry attr : this.attrs.entrySet()) { + markup.append(" ").append(attr.getKey()); + if (attr.getValue() != null) { + markup.append("=\""); + markup.append(xssApi.encodeForHTMLAttr(attr.getValue())); + markup.append("\""); + } + } + markup.append(">"); + if (closeTag) { + markup.append(""); + } + markup.append("\n"); + return markup.toString(); + } + +} diff --git a/src/main/java/io/wcm/wcm/ui/clientlibs/components/IncludeUtil.java b/src/main/java/io/wcm/wcm/ui/clientlibs/components/IncludeUtil.java index ff145a7..02bcf3e 100644 --- a/src/main/java/io/wcm/wcm/ui/clientlibs/components/IncludeUtil.java +++ b/src/main/java/io/wcm/wcm/ui/clientlibs/components/IncludeUtil.java @@ -20,7 +20,10 @@ package io.wcm.wcm.ui.clientlibs.components; import java.lang.reflect.Array; +import java.util.Collections; +import java.util.HashMap; import java.util.List; +import java.util.Map; import java.util.Objects; import java.util.stream.Collectors; @@ -44,7 +47,7 @@ private IncludeUtil() { /** * @return Array of clientlib category names as specified in HTL script */ - public static @Nullable String[] toCategoryArray(Object categories) { + public static @Nullable String[] toArray(Object categories) { String[] categoryArray = null; if (categories instanceof String) { categoryArray = new String[] { (String)categories }; @@ -100,4 +103,34 @@ else if (resourceResolver.getResource(library.getPath()) == null) { return path; } + /** + * Transform list of custom attributes to a map. + * @param customAttributes List of custom attributes in syntax "attr=value" for each item. + * @return Map with custom attributes + */ + public static @NotNull Map getCustomAttributes(@Nullable Object customAttributes) { + String[] customAttributesArray = toArray(customAttributes); + if (customAttributesArray == null) { + return Collections.emptyMap(); + } + Map result = new HashMap<>(); + for (String item : customAttributesArray) { + if (item != null) { + int separator = item.indexOf('='); + String name; + String value; + if (separator > 0) { + name = item.substring(0, separator); + value = item.substring(separator + 1); + } + else { + name = item; + value = null; + } + result.put(name, value); + } + } + return result; + } + } diff --git a/src/main/java/io/wcm/wcm/ui/clientlibs/components/JSInclude.java b/src/main/java/io/wcm/wcm/ui/clientlibs/components/JSInclude.java index bb4a01e..6e33197 100644 --- a/src/main/java/io/wcm/wcm/ui/clientlibs/components/JSInclude.java +++ b/src/main/java/io/wcm/wcm/ui/clientlibs/components/JSInclude.java @@ -19,12 +19,10 @@ */ package io.wcm.wcm.ui.clientlibs.components; -import java.util.Arrays; -import java.util.HashSet; +import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; -import java.util.TreeMap; import javax.annotation.PostConstruct; @@ -51,13 +49,13 @@ @ProviderType public class JSInclude { - private static final Set CROSSORIGIN_ALLOWED_VALUES = new HashSet<>(Arrays.asList( - "anonymous", "use-credentials")); - private static final Set REFERRERPOLICY_ALLOWED_VALUES = new HashSet<>(Arrays.asList( + private static final Set CROSSORIGIN_ALLOWED_VALUES = Set.of( + "anonymous", "use-credentials"); + private static final Set REFERRERPOLICY_ALLOWED_VALUES = Set.of( "no-referrer", "no-referrer-when-downgrade", "origin", "origin-when-cross-origin", - "same-origin", "strict-origin", "strict-origin-when-cross-origin", "unsafe-url")); - private static final Set TYPE_ALLOWED_VALUES = new HashSet<>(Arrays.asList( - "text/javascript", "module")); + "same-origin", "strict-origin", "strict-origin-when-cross-origin", "unsafe-url"); + private static final Set TYPE_ALLOWED_VALUES = Set.of( + "text/javascript", "module"); @SlingObject private ResourceResolver resourceResolver; @@ -84,19 +82,22 @@ public class JSInclude { private String referrerpolicy; @RequestAttribute(injectionStrategy = InjectionStrategy.OPTIONAL) private String type; + @RequestAttribute(injectionStrategy = InjectionStrategy.OPTIONAL) + private Object customAttributes; private String include; @PostConstruct private void activate() { // build include string - String[] categoryArray = IncludeUtil.toCategoryArray(categories); + String[] categoryArray = IncludeUtil.toArray(categories); if (categoryArray != null) { List libraryPaths = IncludeUtil.getLibraryUrls(htmlLibraryManager, resourceResolver, categoryArray, LibraryType.JS); if (!libraryPaths.isEmpty()) { Map attrs = validateAndBuildAttributes(); - this.include = buildIncludeString(libraryPaths, attrs); + Map customAttrs = IncludeUtil.getCustomAttributes(customAttributes); + this.include = buildIncludeString(libraryPaths, attrs, customAttrs); } } } @@ -107,11 +108,11 @@ private void activate() { * @return Map with attribute for script tag */ private @NotNull Map validateAndBuildAttributes() { - Map attrs = new TreeMap<>(); + Map attrs = new HashMap<>(); if (async) { attrs.put("async", null); } - if (CROSSORIGIN_ALLOWED_VALUES.contains(crossorigin)) { + if (crossorigin != null && CROSSORIGIN_ALLOWED_VALUES.contains(crossorigin)) { attrs.put("crossorigin", crossorigin); } if (defer) { @@ -126,10 +127,10 @@ private void activate() { if (StringUtils.isNotEmpty(nonce)) { attrs.put("nonce", xssApi.encodeForHTMLAttr(nonce)); } - if (REFERRERPOLICY_ALLOWED_VALUES.contains(referrerpolicy)) { + if (referrerpolicy != null && REFERRERPOLICY_ALLOWED_VALUES.contains(referrerpolicy)) { attrs.put("referrerpolicy", referrerpolicy); } - if (TYPE_ALLOWED_VALUES.contains(type)) { + if (type != null && TYPE_ALLOWED_VALUES.contains(type)) { attrs.put("type", type); } return attrs; @@ -139,22 +140,18 @@ private void activate() { * Build script tags for all client libraries with the defined custom script tag attributes set. * @param libraryPaths Library paths * @param attrs HTML attributes for script tag + * @param customAttrs Custom HTML attributes for script tag * @return HTML markup with script tags */ - private @NotNull String buildIncludeString(@NotNull List libraryPaths, @NotNull Map attrs) { + private @NotNull String buildIncludeString(@NotNull List libraryPaths, @NotNull Map attrs, + @NotNull Map customAttrs) { StringBuilder markup = new StringBuilder(); for (String libraryPath : libraryPaths) { - markup.append("\n"); + HtmlTagBuilder builder = new HtmlTagBuilder("script", true, xssApi); + builder.setAttrs(attrs); + builder.setAttrs(customAttrs); + builder.setAttr("src", libraryPath); + markup.append(builder.build()); } return markup.toString(); } diff --git a/src/main/webapp/app-root/sightly/templates/clientlib.html b/src/main/webapp/app-root/sightly/templates/clientlib.html index 5b5a0e1..b412248 100644 --- a/src/main/webapp/app-root/sightly/templates/clientlib.html +++ b/src/main/webapp/app-root/sightly/templates/clientlib.html @@ -5,30 +5,33 @@ * @param crossorigin anonymous|use-credentials see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-crossorigin * @param defer true|false see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-defer * @param integrity see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-integrity - * @param nomodule true|false https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-nomodule - * @param nonce https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-nonce + * @param nomodule true|false see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-nomodule + * @param nonce see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-nonce * @param referrerpolicy see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-referrerpolicy * @param type see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-type + * @param customAttributes List of custom attributes, each list item in syntax 'attr=value' or just 'attr' */--> -