io.micronaut.views.soy.SoySauceViewsRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-views-soy Show documentation
Provides integration between Micronaut and server-side views technologies
The newest version!
/*
 * Copyright 2017-2023 original 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.
 */
package io.micronaut.views.soy;

import com.google.template.soy.SoyFileSet;
import com.google.template.soy.data.SoyTemplate;
import com.google.template.soy.data.SoyValueProvider;
import com.google.template.soy.error.SoyCompilationException;
import com.google.template.soy.jbcsrc.api.RenderResult;
import com.google.template.soy.jbcsrc.api.SoySauce;
import com.google.template.soy.shared.SoyCssRenamingMap;
import com.google.template.soy.shared.SoyIdRenamingMap;
import io.micronaut.context.annotation.Requires;
import io.micronaut.core.io.Writable;
import io.micronaut.core.util.ArgumentUtils;
import io.micronaut.http.HttpRequest;
import io.micronaut.views.ViewUtils;
import io.micronaut.views.ViewsConfiguration;
import io.micronaut.views.ViewsRenderer;
import io.micronaut.views.csp.CspConfiguration;
import io.micronaut.views.csp.CspFilter;
import io.micronaut.views.exceptions.ViewRenderingException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import jakarta.inject.Inject;
import jakarta.inject.Singleton;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ExecutionException;


/**
 * Renders views with a Soy engine.
 *
 * @author Sam Gammon ([email protected])
 * @since 1.2.1
 * @param  The model type
 */
@Requires(classes = SoySauce.class)
@Requires(classes = HttpRequest.class)
@Singleton
@SuppressWarnings({"WeakerAccess", "UnstableApiUsage"})
public class SoySauceViewsRenderer implements ViewsRenderer> {

    private static final Logger LOG = LoggerFactory.getLogger(SoySauceViewsRenderer.class);
    private static final String INJECTED_NONCE_PROPERTY = "csp_nonce";

    protected final ViewsConfiguration viewsConfiguration;
    protected final SoyViewsRendererConfigurationProperties soyMicronautConfiguration;
    protected final SoyNamingMapProvider namingMapProvider;
    protected final SoySauce soySauce;
    private final boolean injectNonce;

    /**
     * @param viewsConfiguration Views configuration properties.
     * @param cspConfiguration Content-Security-Policy configuration.
     * @param namingMapProvider Soy naming map provider
     * @param soyConfiguration   Soy configuration properties.
     */
    @Inject
    public SoySauceViewsRenderer(ViewsConfiguration viewsConfiguration,
                                 @Nullable CspConfiguration cspConfiguration,
                                 @Nullable SoyNamingMapProvider namingMapProvider,
                                 SoyViewsRendererConfigurationProperties soyConfiguration) {
        this.viewsConfiguration = viewsConfiguration;
        this.soyMicronautConfiguration = soyConfiguration;
        this.namingMapProvider = namingMapProvider;
        this.injectNonce = cspConfiguration != null && cspConfiguration.isNonceEnabled();
        final SoySauce precompiled = soyConfiguration.getCompiledTemplates();
        if (precompiled != null) {
            this.soySauce = precompiled;
        } else {
            LOG.warn("Compiling Soy templates (this may take a moment)...");
            SoyFileSet fileSet = soyConfiguration.getFileSet();
            if (fileSet == null) {
                throw new IllegalStateException(
                        "Unable to load Soy templates: no file set, no compiled templates provided.");
            }
            try {
                this.soySauce = fileSet.compileTemplates();
            } catch (SoyCompilationException se) {
                throw new ViewRenderingException(
                    "Soy template compilation failed: " + se.getMessage(), se);
            }
        }
    }


    /**
     * @param viewName view name to be rendered
     * @param data     response body to render it with a view
     * @param request  HTTP request
     * @return A writable where the view will be written to.
     */
    @NonNull
    @Override
    public Writable render(@NonNull String viewName,
                           @Nullable T data,
                           @Nullable HttpRequest request) {
        ArgumentUtils.requireNonNull("viewName", viewName);

        Map ijOverlay = new HashMap<>(1);
        Map context = ViewUtils.modelOf(data);
        final SoySauce.Renderer renderer = soySauce.newRenderer(new SoyTemplate() {
            @Override
            public String getTemplateName() {
                return viewName;
            }

            @Override
            public Map getParamsAsMap() {
                return null;
            }
        });
        renderer.setData(context);
        if (injectNonce) {
            Optional