Merge branch 'develop' into feature/tag-dates

scm-webapp/src/main/java/sonia/scm/api/WebApplicationExceptionMapper.java

@@ -0,0 +1,63 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
+import sonia.scm.api.v2.resources.ErrorDto;
+import sonia.scm.web.VndMediaType;
+
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.ext.ExceptionMapper;
+import javax.ws.rs.ext.Provider;
+import java.util.Collections;
+
+@Provider
+public class WebApplicationExceptionMapper implements ExceptionMapper<WebApplicationException> {
+
+  private static final Logger LOG = LoggerFactory.getLogger(WebApplicationExceptionMapper.class);
+
+  private static final String ERROR_CODE = "FVS9JY1T21";
+
+  @Override
+  public Response toResponse(WebApplicationException exception) {
+    LOG.trace("caught web application exception", exception);
+
+    ErrorDto errorDto = new ErrorDto();
+    errorDto.setMessage(exception.getMessage());
+    errorDto.setContext(Collections.emptyList());
+    errorDto.setErrorCode(ERROR_CODE);
+    errorDto.setTransactionId(MDC.get("transaction_id"));
+
+    Response originalResponse = exception.getResponse();
+
+    return Response.fromResponse(originalResponse)
+      .entity(errorDto)
+      .type(VndMediaType.ERROR_TYPE)
+      .build();
+  }
+}

scm-webapp/src/main/java/sonia/scm/api/v2/ContentTypeResolver.java

@@ -0,0 +1,51 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2;
+
+import com.github.sdorra.spotter.ContentType;
+import com.github.sdorra.spotter.ContentTypeDetector;
+import com.github.sdorra.spotter.Language;
+
+public final class ContentTypeResolver {
+
+  private static final ContentTypeDetector PATH_BASED = ContentTypeDetector.builder()
+    .defaultPathBased().boost(Language.MARKDOWN)
+    .bestEffortMatch();
+
+  private static final ContentTypeDetector PATH_AND_CONTENT_BASED = ContentTypeDetector.builder()
+    .defaultPathAndContentBased().boost(Language.MARKDOWN)
+    .bestEffortMatch();
+
+  private ContentTypeResolver() {
+  }
+
+  public static ContentType resolve(String path) {
+    return PATH_BASED.detect(path);
+  }
+
+  public static ContentType resolve(String path, byte[] contentPrefix) {
+    return PATH_AND_CONTENT_BASED.detect(path, contentPrefix);
+  }
+}

scm-webapp/src/main/java/sonia/scm/api/v2/resources/ContentResource.java

@@ -25,7 +25,6 @@
 package sonia.scm.api.v2.resources;
 
 import com.github.sdorra.spotter.ContentType;
-import com.github.sdorra.spotter.ContentTypes;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.media.Content;
@@ -34,6 +33,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import sonia.scm.NotFoundException;
+import sonia.scm.api.v2.ContentTypeResolver;
 import sonia.scm.repository.NamespaceAndName;
 import sonia.scm.repository.api.RepositoryService;
 import sonia.scm.repository.api.RepositoryServiceFactory;
@@ -204,7 +204,7 @@ public class ContentResource {
   }
 
   private void appendContentHeader(String path, byte[] head, Response.ResponseBuilder responseBuilder) {
-    ContentType contentType = ContentTypes.detect(path, head);
+    ContentType contentType = ContentTypeResolver.resolve(path, head);
     responseBuilder.header("Content-Type", contentType.getRaw());
     contentType.getLanguage().ifPresent(
       language -> responseBuilder.header(ProgrammingLanguages.HEADER, ProgrammingLanguages.getValue(language))

scm-webapp/src/main/java/sonia/scm/api/v2/resources/DiffResultToDiffResultDtoMapper.java

@@ -24,10 +24,10 @@
 
 package sonia.scm.api.v2.resources;
 
-import com.github.sdorra.spotter.ContentTypes;
 import com.github.sdorra.spotter.Language;
 import com.google.inject.Inject;
 import de.otto.edison.hal.Links;
+import sonia.scm.api.v2.ContentTypeResolver;
 import sonia.scm.repository.Repository;
 import sonia.scm.repository.api.DiffFile;
 import sonia.scm.repository.api.DiffLine;
@@ -120,7 +120,7 @@ class DiffResultToDiffResultDtoMapper {
     dto.setOldRevision(file.getOldRevision());
 
 
-    Optional<Language> language = ContentTypes.detect(path).getLanguage();
+    Optional<Language> language = ContentTypeResolver.resolve(path).getLanguage();
     language.ifPresent(value -> dto.setLanguage(ProgrammingLanguages.getValue(value)));
 
     List<DiffResultDto.HunkDto> hunks = new ArrayList<>();

scm-webapp/src/main/java/sonia/scm/api/v2/resources/SourceRootResource.java

@@ -21,7 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-    
+
 package sonia.scm.api.v2.resources;
 
 import io.swagger.v3.oas.annotations.Operation;
@@ -40,7 +40,6 @@ import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
 import javax.ws.rs.QueryParam;
 import java.io.IOException;
-import java.net.URLDecoder;
 
 import static sonia.scm.ContextEntry.ContextBuilder.entity;
 import static sonia.scm.NotFoundException.notFound;
@@ -88,7 +87,7 @@ public class SourceRootResource {
       browseCommand.setPath(path);
       browseCommand.setOffset(offset);
       if (revision != null && !revision.isEmpty()) {
-        browseCommand.setRevision(URLDecoder.decode(revision, "UTF-8"));
+        browseCommand.setRevision(revision);
       }
       BrowserResult browserResult = browseCommand.getBrowserResult();
 

scm-webapp/src/main/java/sonia/scm/lifecycle/DefaultRestarter.java

@@ -31,9 +31,8 @@ import javax.inject.Singleton;
 
 @Singleton
 public class DefaultRestarter implements Restarter {
-
-  private ScmEventBus eventBus;
-  private RestartStrategy strategy;
+  private final ScmEventBus eventBus;
+  private final RestartStrategy strategy;
 
   @Inject
   public DefaultRestarter() {

scm-webapp/src/main/java/sonia/scm/update/MigrationWizardServlet.java

@@ -61,6 +61,7 @@ import static java.util.Comparator.comparing;
 class MigrationWizardServlet extends HttpServlet {
 
   private static final Logger LOG = LoggerFactory.getLogger(MigrationWizardServlet.class);
+  static final String PROPERTY_WAIT_TIME = "sonia.scm.restart-migration.wait";
 
   private final XmlRepositoryV1UpdateStep repositoryV1UpdateStep;
   private final DefaultMigrationStrategyDAO migrationStrategyDao;
@@ -129,7 +130,7 @@ class MigrationWizardServlet extends HttpServlet {
 
     repositoryLineEntries.stream()
       .forEach(
-        entry-> {
+        entry -> {
           String id = entry.getId();
           String protocol = entry.getType();
           String originalName = entry.getOriginalName();
@@ -145,7 +146,7 @@ class MigrationWizardServlet extends HttpServlet {
 
     if (restarter.isSupported()) {
       respondWithTemplate(resp, model, "templates/repository-migration-restart.mustache");
-      restarter.restart(MigrationWizardServlet.class, "wrote migration data");
+      new Thread(this::restart).start();
     } else {
       respondWithTemplate(resp, model, "templates/repository-migration-manual-restart.mustache");
       LOG.error("Restarting is not supported on this platform.");
@@ -153,6 +154,19 @@ class MigrationWizardServlet extends HttpServlet {
     }
   }
 
+  private void restart() {
+    String wait = System.getProperty(PROPERTY_WAIT_TIME);
+    if (!Strings.isNullOrEmpty(wait)) {
+      try {
+        Thread.sleep(Long.parseLong(wait));
+      } catch (InterruptedException e) {
+        LOG.error("error on waiting before restart", e);
+        Thread.currentThread().interrupt();
+      }
+    }
+    restarter.restart(MigrationWizardServlet.class, "wrote migration data");
+  }
+
   private List<RepositoryLineEntry> getRepositoryLineEntries() {
     List<V1Repository> repositoriesWithoutMigrationStrategies =
       repositoryV1UpdateStep.getRepositoriesWithoutMigrationStrategies();

scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java

@@ -21,7 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-    
+
 package sonia.scm.web.i18n;
 
 
@@ -31,14 +31,14 @@ import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.github.legman.Subscribe;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.inject.Singleton;
-import lombok.extern.slf4j.Slf4j;
-import sonia.scm.NotFoundException;
-import sonia.scm.SCMContext;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import sonia.scm.SCMContextProvider;
 import sonia.scm.Stage;
-import sonia.scm.lifecycle.RestartEvent;
 import sonia.scm.cache.Cache;
 import sonia.scm.cache.CacheManager;
 import sonia.scm.filter.WebElement;
+import sonia.scm.lifecycle.RestartEvent;
 import sonia.scm.plugin.PluginLoader;
 
 import javax.inject.Inject;
@@ -51,11 +51,6 @@ import java.net.URL;
 import java.util.Enumeration;
 import java.util.Iterator;
 import java.util.Optional;
-import java.util.function.BiConsumer;
-import java.util.function.Function;
-
-import static sonia.scm.ContextEntry.ContextBuilder.entity;
-import static sonia.scm.NotFoundException.notFound;
 
 
 /**
@@ -63,122 +58,109 @@ import static sonia.scm.NotFoundException.notFound;
  */
 @Singleton
 @WebElement(value = I18nServlet.PATTERN, regex = true)
-@Slf4j
 public class I18nServlet extends HttpServlet {
 
+  private static final Logger LOG = LoggerFactory.getLogger(I18nServlet.class);
+
   public static final String PLUGINS_JSON = "plugins.json";
   public static final String PATTERN = "/locales/[a-z\\-A-Z]*/" + PLUGINS_JSON;
   public static final String CACHE_NAME = "sonia.cache.plugins.translations";
 
+  private final SCMContextProvider context;
   private final ClassLoader classLoader;
   private final Cache<String, JsonNode> cache;
-  private static ObjectMapper objectMapper = new ObjectMapper();
+  private final ObjectMapper objectMapper = new ObjectMapper();
 
 
   @Inject
-  public I18nServlet(PluginLoader pluginLoader, CacheManager cacheManager) {
+  public I18nServlet(SCMContextProvider context, PluginLoader pluginLoader, CacheManager cacheManager) {
+    this.context = context;
     this.classLoader = pluginLoader.getUberClassLoader();
     this.cache = cacheManager.getCache(CACHE_NAME);
   }
 
   @Subscribe(async = false)
   public void handleRestartEvent(RestartEvent event) {
-    log.debug("Clear cache on restart event with reason {}", event.getReason());
+    LOG.debug("Clear cache on restart event with reason {}", event.getReason());
     cache.clear();
   }
 
-  private JsonNode getCollectedJson(String path,
-                                    Function<String, Optional<JsonNode>> jsonFileProvider,
-                                    BiConsumer<String, JsonNode> createdJsonFileConsumer) {
-    return Optional.ofNullable(jsonFileProvider.apply(path)
-      .orElseGet(() -> {
-          Optional<JsonNode> createdFile = collectJsonFile(path);
-          createdFile.ifPresent(map -> createdJsonFileConsumer.accept(path, map));
-          return createdFile.orElse(null);
-        }
-      )).orElseThrow(() -> notFound(entity("jsonprovider", path)));
-  }
-
   @VisibleForTesting
   @Override
-  protected void doGet(HttpServletRequest req, HttpServletResponse response) {
+  protected void doGet(HttpServletRequest request, HttpServletResponse response) {
+    String path = request.getServletPath();
+    try {
+      Optional<JsonNode> json = findJson(path);
+      if (json.isPresent()) {
+        write(response, json.get());
+      } else {
+        LOG.debug("could not find translation at {}", path);
+        response.setStatus(HttpServletResponse.SC_NOT_FOUND);
+      }
+    } catch (IOException ex) {
+      LOG.error("Error on getting the translation of the plugins", ex);
+      response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
+    }
+  }
+
+  private void write(HttpServletResponse response, JsonNode jsonNode) throws IOException {
     response.setCharacterEncoding("UTF-8");
     response.setContentType("application/json");
     response.setHeader("Cache-Control", "no-cache");
-    try (PrintWriter out = response.getWriter()) {
-      String path = req.getServletPath();
-      Function<String, Optional<JsonNode>> jsonFileProvider = usedPath -> Optional.empty();
-      BiConsumer<String, JsonNode> createdJsonFileConsumer = (usedPath, jsonNode) -> log.debug("A json File is created from the path {}", usedPath);
-      if (isProductionStage()) {
-        log.debug("In Production Stage get the plugin translations from the cache");
-        jsonFileProvider = usedPath -> Optional.ofNullable(
-          cache.get(usedPath));
-        createdJsonFileConsumer = createdJsonFileConsumer
-          .andThen((usedPath, jsonNode) -> log.debug("Put the created json File in the cache with the key {}", usedPath))
-          .andThen(cache::put);
-      }
-      objectMapper.writeValue(out, getCollectedJson(path, jsonFileProvider, createdJsonFileConsumer));
-    } catch (IOException e) {
-      log.error("Error on getting the translation of the plugins", e);
-      response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
-    } catch (NotFoundException e) {
-      log.error("Plugin translations are not found", e);
-      response.setStatus(HttpServletResponse.SC_NOT_FOUND);
+
+    try (PrintWriter writer = response.getWriter()) {
+      objectMapper.writeValue(writer, jsonNode);
     }
   }
 
+  public Optional<JsonNode> findJson(String path) throws IOException {
+    if (isProductionStage()) {
+      return findJsonCached(path);
+    }
+    return collectJsonFile(path);
+  }
+
+  private Optional<JsonNode> findJsonCached(String path) throws IOException {
+    JsonNode jsonNode = cache.get(path);
+    if (jsonNode != null) {
+      LOG.debug("return json node from cache for path {}", path);
+      return Optional.of(jsonNode);
+    }
+
+    LOG.debug("collect json for path {}", path);
+    Optional<JsonNode> collected = collectJsonFile(path);
+    collected.ifPresent(node -> cache.put(path, node));
+    return collected;
+  }
+
   @VisibleForTesting
   protected boolean isProductionStage() {
-    return SCMContext.getContext().getStage() == Stage.PRODUCTION;
+    return context.getStage() == Stage.PRODUCTION;
   }
 
-  /**
-   * Return a collected Json File as JsonNode from the given path from all plugins in the class path
-   *
-   * @param path the searched resource path
-   * @return a collected Json File as JsonNode from the given path from all plugins in the class path
-   */
   @VisibleForTesting
-  protected Optional<JsonNode> collectJsonFile(String path) {
-    log.debug("Collect plugin translations from path {} for every plugin", path);
+  private Optional<JsonNode> collectJsonFile(String path) throws IOException {
+    LOG.debug("Collect plugin translations from path {} for every plugin", path);
     JsonNode mergedJsonNode = null;
-    try {
-      Enumeration<URL> resources = classLoader.getResources(path.replaceFirst("/", ""));
-      while (resources.hasMoreElements()) {
-        URL url = resources.nextElement();
-        JsonNode jsonNode = objectMapper.readTree(url);
-        if (mergedJsonNode != null) {
-          merge(mergedJsonNode, jsonNode);
-        } else {
-          mergedJsonNode = jsonNode;
-        }
+    Enumeration<URL> resources = classLoader.getResources(path.replaceFirst("/", ""));
+    while (resources.hasMoreElements()) {
+      URL url = resources.nextElement();
+      JsonNode jsonNode = objectMapper.readTree(url);
+      if (mergedJsonNode != null) {
+        merge(mergedJsonNode, jsonNode);
+      } else {
+        mergedJsonNode = jsonNode;
       }
-    } catch (IOException e) {
-      log.error("Error on loading sources from {}", path, e);
-      return Optional.empty();
     }
+
     return Optional.ofNullable(mergedJsonNode);
   }
 
-
-  /**
-   * Merge the <code>updateNode</code> into the <code>mainNode</code> and return it.
-   *
-   * This is not a deep merge.
-   *
-   * @param mainNode the main node
-   * @param updateNode the update node
-   * @return the merged mainNode
-   */
-  @VisibleForTesting
-  protected JsonNode merge(JsonNode mainNode, JsonNode updateNode) {
+  private JsonNode merge(JsonNode mainNode, JsonNode updateNode) {
     Iterator<String> fieldNames = updateNode.fieldNames();
-
     while (fieldNames.hasNext()) {
-
       String fieldName = fieldNames.next();
       JsonNode jsonNode = mainNode.get(fieldName);
-
       if (jsonNode != null) {
         mergeNode(updateNode, fieldName, jsonNode);
       } else {