com.github.jknack.handlebars.EscapingStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/**
 * Copyright (c) 2012-2015 Edgar Espina
 *
 * This file is part of Handlebars.java.
 *
 * 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.
 */
package com.github.jknack.handlebars;

import org.apache.commons.text.StringEscapeUtils;
import org.apache.commons.text.translate.LookupTranslator;
import java.util.HashMap;
import java.util.Map;

/**
 *  
 *  A strategy for determining how to escape a variable ({{variable}})..
 *  
 *  
 *  Usage:
 *  
 *
 *   *     EscapingStrategy escapingStrategy = new EscapingStrategy() {
 *        public String escape(final CharSequence value) {
 *          // return the character sequence escaped however you want
 *        }
 *     };
 *     Handlebars handlebars = new Handlebars().with(escapingStrategy);
 *  
 *
 *  @author Tristan Burch
 *  @since 1.2.0
 *
 * @deprecated com.github.jknack.handlebars package is deprecated and marked for removal in subsequent releases which will involve removal of the handlebars dependency in AEM.
 */
@Deprecated(since = "2024-07-10")
public interface EscapingStrategy {

    /**
     *  Handlebars escaping strategy. Escape is done via a string map. See
     *  {@link EscapingStrategy#HTML_ENTITY}.
     *
     *  @author edgar
     *  @since 4.0.4
     *
     * @deprecated com.github.jknack.handlebars package is deprecated and marked for removal in subsequent releases which will involve removal of the handlebars dependency in AEM.
     */
    @Deprecated(since = "2024-07-10")
    class Hbs implements EscapingStrategy {

        /**
         * EMPTY.
         */
        private static final String EMPTY = "";

        /**
         * Translator.
         */
        private final LookupTranslator translator;

        /**
         * Creates a new {@link Hbs} escaping strategy.
         *
         * @param escapeMap A escape map.
         */
        public Hbs(final String[][] escapeMap) {
            this(escapeMap(escapeMap));
        }

        /**
         * Creates a new {@link Hbs} escaping strategy.
         *
         * @param escapeMap A escape map.
         */
        public Hbs(final Map escapeMap) {
            translator = new LookupTranslator(escapeMap);
        }

        @Override
        public CharSequence escape(final CharSequence value) {
            if (value instanceof Handlebars.SafeString) {
                return ((Handlebars.SafeString) value).content;
            }
            return value == null || value.length() == 0 ? EMPTY : translator.translate(value);
        }

        /**
         * Convert a table to a hash (internal usage).
         *
         * @param table Table.
         * @return A hash.
         */
        private static Map escapeMap(final String[][] table) {
            Map result = new HashMap<>();
            for (String[] row : table) {
                result.put(row[0], row[1]);
            }
            return result;
        }
    }

    /**
     * The default HTML Entity escaping strategy.
     */
    EscapingStrategy HTML_ENTITY = new Hbs(new String[][] { { "<", "<" }, { ">", ">" }, { "\"", """ }, { "'", "'" }, { "`", "`" }, { "&", "&" }, { "=", "=" } });

    /**
     * Like {@link #HTML_ENTITY} but ignores =.
     */
    EscapingStrategy HBS3 = new Hbs(new String[][] { { "<", "<" }, { ">", ">" }, { "\"", """ }, { "'", "'" }, { "`", "`" }, { "&", "&" } });

    /**
     * Default escaping strategy for Handlebars 4.x .
     */
    EscapingStrategy HBS4 = HTML_ENTITY;

    /**
     * Escape variable for CSV.
     */
    EscapingStrategy CSV = value -> value == null ? null : StringEscapeUtils.escapeCsv(value.toString());

    /**
     * Escape variable for XML.
     */
    EscapingStrategy XML = value -> value == null ? null : StringEscapeUtils.escapeXml11(value.toString());

    /**
     * Escape variable for JavaScript.
     */
    EscapingStrategy JS = value -> value == null ? null : StringEscapeUtils.escapeEcmaScript(value.toString());

    /**
     * NOOP escaping.
     */
    EscapingStrategy NOOP = value -> value;

    /**
     * Default escaping strategy.
     */
    EscapingStrategy DEF = HBS4;

    /**
     * Escape the {@link java.lang.CharSequence}.
     *
     * @param value the character sequence to be escaped.
     * @return the escaped character sequence.
     */
    CharSequence escape(CharSequence value);
}