| // Copyright (C) 2019 The Android Open Source Project |
| // |
| // 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.google.gerrit.httpd.raw; |
| |
| import static com.google.template.soy.data.ordainers.GsonOrdainer.serializeObject; |
| |
| import com.google.common.base.Strings; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.flogger.FluentLogger; |
| import com.google.gerrit.common.Nullable; |
| import com.google.gerrit.common.UsedAt; |
| import com.google.gerrit.common.UsedAt.Project; |
| import com.google.gerrit.extensions.api.GerritApi; |
| import com.google.gerrit.extensions.api.accounts.AccountApi; |
| import com.google.gerrit.extensions.api.config.Server; |
| import com.google.gerrit.extensions.restapi.AuthException; |
| import com.google.gerrit.extensions.restapi.RestApiException; |
| import com.google.gerrit.json.OutputFormat; |
| import com.google.gson.Gson; |
| import com.google.template.soy.data.SanitizedContent; |
| import java.net.URI; |
| import java.net.URISyntaxException; |
| import java.util.HashMap; |
| import java.util.Map; |
| import java.util.function.Function; |
| |
| /** Helper for generating parts of {@code index.html}. */ |
| public class IndexHtmlUtil { |
| private static final FluentLogger logger = FluentLogger.forEnclosingClass(); |
| |
| /** |
| * Returns both static and dynamic parameters of {@code index.html}. The result is to be used when |
| * rendering the soy template. |
| */ |
| public static ImmutableMap<String, Object> templateData( |
| GerritApi gerritApi, |
| String canonicalURL, |
| String cdnPath, |
| String faviconPath, |
| Map<String, String[]> urlParameterMap, |
| Function<String, SanitizedContent> urlInScriptTagOrdainer) |
| throws URISyntaxException, RestApiException { |
| return ImmutableMap.<String, Object>builder() |
| .putAll( |
| staticTemplateData( |
| canonicalURL, cdnPath, faviconPath, urlParameterMap, urlInScriptTagOrdainer)) |
| .putAll(dynamicTemplateData(gerritApi)) |
| .build(); |
| } |
| |
| /** Returns dynamic parameters of {@code index.html}. */ |
| @UsedAt(Project.GOOGLE) |
| public static Map<String, Map<String, SanitizedContent>> dynamicTemplateData(GerritApi gerritApi) |
| throws RestApiException { |
| Gson gson = OutputFormat.JSON_COMPACT.newGson(); |
| Map<String, SanitizedContent> initialData = new HashMap<>(); |
| Server serverApi = gerritApi.config().server(); |
| initialData.put("\"/config/server/info\"", serializeObject(gson, serverApi.getInfo())); |
| initialData.put("\"/config/server/version\"", serializeObject(gson, serverApi.getVersion())); |
| initialData.put("\"/config/server/top-menus\"", serializeObject(gson, serverApi.topMenus())); |
| |
| try { |
| AccountApi accountApi = gerritApi.accounts().self(); |
| initialData.put("\"/accounts/self/detail\"", serializeObject(gson, accountApi.get())); |
| initialData.put( |
| "\"/accounts/self/preferences\"", serializeObject(gson, accountApi.getPreferences())); |
| initialData.put( |
| "\"/accounts/self/preferences.diff\"", |
| serializeObject(gson, accountApi.getDiffPreferences())); |
| initialData.put( |
| "\"/accounts/self/preferences.edit\"", |
| serializeObject(gson, accountApi.getEditPreferences())); |
| } catch (AuthException e) { |
| logger.atFine().log("Can't inline account-related data because user is unauthenticated"); |
| // Don't render data |
| // TODO(hiesel): Tell the client that the user is not authenticated so that it doesn't have to |
| // fetch anyway. This requires more client side modifications. |
| } |
| return ImmutableMap.of("gerritInitialData", initialData); |
| } |
| |
| /** Returns all static parameters of {@code index.html}. */ |
| static Map<String, Object> staticTemplateData( |
| String canonicalURL, |
| String cdnPath, |
| String faviconPath, |
| Map<String, String[]> urlParameterMap, |
| Function<String, SanitizedContent> urlInScriptTagOrdainer) |
| throws URISyntaxException { |
| String canonicalPath = computeCanonicalPath(canonicalURL); |
| |
| String staticPath = ""; |
| if (cdnPath != null) { |
| staticPath = cdnPath; |
| } else if (canonicalPath != null) { |
| staticPath = canonicalPath; |
| } |
| |
| SanitizedContent sanitizedStaticPath = urlInScriptTagOrdainer.apply(staticPath); |
| ImmutableMap.Builder<String, Object> data = ImmutableMap.builder(); |
| |
| if (canonicalPath != null) { |
| data.put("canonicalPath", canonicalPath); |
| } |
| if (sanitizedStaticPath != null) { |
| data.put("staticResourcePath", sanitizedStaticPath); |
| } |
| if (faviconPath != null) { |
| data.put("faviconPath", faviconPath); |
| } |
| if (urlParameterMap.containsKey("ce")) { |
| data.put("polyfillCE", "true"); |
| } |
| if (urlParameterMap.containsKey("sd")) { |
| data.put("polyfillSD", "true"); |
| } |
| if (urlParameterMap.containsKey("sc")) { |
| data.put("polyfillSC", "true"); |
| } |
| return data.build(); |
| } |
| |
| private static String computeCanonicalPath(@Nullable String canonicalURL) |
| throws URISyntaxException { |
| if (Strings.isNullOrEmpty(canonicalURL)) { |
| return ""; |
| } |
| |
| // If we serving from a sub-directory rather than root, determine the path |
| // from the cannonical web URL. |
| URI uri = new URI(canonicalURL); |
| return uri.getPath().replaceAll("/$", ""); |
| } |
| |
| private IndexHtmlUtil() {} |
| } |